Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
124,404 Commits 6 Branches 593 Tags 2.8 GiB
Commit Graph

16 Commits

Author SHA1 Message Date
Carol Willing 9effa0ff06
Add lightweight comments to conf.py and update docs readme (GH-126100) 
* Update contributing contact info in readme

* Add lightweight comments to improve docs workflow understanding

* Apply code review suggestions from @hugovk

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

* Add code review suggestion from @AA-Turner

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

* Update Doc/conf.py

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

* Update Doc/conf.py

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

* Update Doc/conf.py

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

---------

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2024-10-29 17:45:03 +00:00
Hugo van Kemenade ead676516d
Doc/README: Document 'make htmllive' (#120692) 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
 2024-06-25 12:08:55 +03:00
Julien Palard 4067c6d7fe
gh-86404: Doc: Drop now unused make suspicious and rstlint. (GH-98179) 
They have been replaced by
[sphinx-lint](https://github.com/sphinx-contrib/sphinx-lint).
 2022-10-11 15:31:33 +02:00
NoSuck 0179a82caa
closes gh-97650: correct sphinx executable (gh-97651) 2022-09-29 15:53:41 -07:00
slateny 9dc4aae8e9
Link to GitHub instead of BPO for CPython bug tracker (GH-92221) 2022-05-03 22:40:36 +08:00
Julien Palard bcafab849e
[doc]: Spotted errors while working on rstlint. (GH-30879) 
Also ignored some `make suspicious` false positives while assuring
true positives were properly seen by rstlint.
 2022-01-27 08:57:43 +01:00
Łukasz Langa 55fa87b1ef
bpo-44756: [docs] revert automated virtual environment creation on `make html` (GH-27635) 
It turned out to be disruptive for downstream distributors.
 2021-08-06 20:13:59 +02:00
Jack DeVries d22c876d5a
bpo-44756: in ./Doc, `make build` depends on `make html` (#27403) 
- venv rule is now conditional, and only does anything if $VENVDIR does not exist
- add rule "clean-venv"
 2021-07-28 15:13:28 +02:00
Julien Palard 46ed90dd01
Doc: Add an optional obsolete header. (GH-13638) 2019-05-29 18:34:04 +02:00
Stéphane Wirtel 599bfa18f8 bpo-34324: Doc README wrong directory name for venv (GH-8650) 
In the documentation, the `env` directory is specified when we execute
the `make venv` command. But in the code, `make venv` will create the
virtualenv inside the `venv` directory (defined by `VENVDIR`)
 2018-08-09 08:05:31 -07:00
Jon Wayne Parrott bf63e8d55f bpo-30607: Use external python-doc-theme (GH-2017) 2018-03-01 16:02:50 -05:00
Ned Deily 122fc136b3
Revert "bpo-30487: automatically create a venv and install Sphinx when running make (GH-4346)" (#4592) 
Fix breakage documented in bpo-32149.
This reverts commit d8d6b91221.
 2017-11-27 17:07:32 -05:00
Caleb Hattingh d8d6b91221 bpo-30487: automatically create a venv and install Sphinx when running make (GH-4346) 2017-11-26 15:18:30 -06:00
Ned Deily 590665c399 bpo-31036: Allow sphinx and blurb to be found automatically (#3440) 
Rather than requiring the path to blurb and/or sphinx-build to be specified to the make rule, enhance the Doc/Makefile to look for each first in a virtual environment created by make venv and, if not found, look on the normal process PATH. This allows the Doc/Makefile to take advantage of an installed spinx-build or blurb and, thus, do the right thing most of the time. Also, make the directory for the venv be configurable and document the `make venv` target.
 2017-09-07 17:17:53 -07:00
Lisa Hewus Fresh 384899dfae bpo-30737: Update DevGuide links to new URL (GH-3228) 
Update old devguide links from https://docs.python.org/devguide to https://devguide.python.org
 2017-08-30 09:37:43 -07:00
Roger b3f1f59cf4 Rename Doc/README.txt to Doc/README.rst and add formatting (#104) 
* Reformat Doc/README.txt to Doc/README.rst

* Update mention of Doc/README.rst

* Update mention of README.txt to README.rst

* Make line fold

* rstlint ignore Doc/README.rst

* conf.py ignore Doc/README.rst

* Update issue tracker url in Docs/README.rst
 2017-02-15 23:54:05 +01:00