| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| |
|
|
| |
They have been replaced by
[sphinx-lint](https://github.com/sphinx-contrib/sphinx-lint).
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* Restore default role check in `make check`.
* Options first, then files.
* Update `make.bat` too.
* Add a comment explaining the extra options.
* No reason to ignore the README.rst.
* Enable default-role check in sphinx-lint.
Co-authored-by: Julien Palard <julien@palard.fr>
* Update sphinx-lint default-role check.
* Fix use of the default role in the docs.
* Update make.bat to check for the default role too.
* Fix comment in make.bat.
Co-authored-by: Julien Palard <julien@palard.fr>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
(GH-32354)
Also updated `make -C htmlview` so it used a full path with `file://`, because the original didn't open the page (macOS).
For example:
```sh
cd Doc
# Doesn't open anything:
python3 -c "import webbrowser; webbrowser.open('build/html/index.html')"
# Opens the docs page e.g. file:///Users/hugo/github/cpython/Doc/build/html/index.html :
python3 -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('build/html/index.html'))"
```
https://bugs.python.org/issue36329
|
| | |
|
| |
|
|
|
|
|
|
|
|
| |
[user@localhost]$ make serve # default configuration, no change
python3 ../Tools/scripts/serve.py build/html
Serving build/html on port 8000, control-C to stop
^CShutting down.
[user@localhost]$ make serve SERVE_PORT=8080 # new option
python3 ../Tools/scripts/serve.py build/html 8080
Serving build/html on port 8080, control-C to stop
|
| |
|
|
|
| |
* bpo-42238: [doc] Announce the future removal of make suspicous.
* Add a news entry.
|
| |
|
|
|
| |
html` (GH-27635)
It turned out to be disruptive for downstream distributors.
|
| |
|
|
| |
- venv rule is now conditional, and only does anything if $VENVDIR does not exist
- add rule "clean-venv"
|
| | |
|
| |
|
|
|
| |
It probably helped a lot a while back, but may not be as usefull
today. We'll continue monitoring it before deletion, so true
positives can be migrated to rstlint.
|
| | |
|
| |
|
|
|
|
|
| |
Doc/requirements.txt becomes the reference for packages and package
versions needed to build the Python documentation.
* Doc/Makefile now uses Doc/requirements.txt
* .travis.yml now uses "make env" of Doc/Makefile
|
| |
|
|
| |
setuptools 50.0.2 is now compatible with Python 3.10:
https://github.com/pypa/setuptools/pull/2361
|
| | |
|
| |
|
| |
See https://github.com/pypa/setuptools/pull/2361
|
| | |
|
| | |
|
| |
|
|
|
|
|
|
|
| |
In the table model used by docutils, the `cols` attribute of `tgroup`
nodes is mandatory, see [1]. It is used in texinfo builder in [2].
[1]: https://www.oasis-open.org/specs/tm9901.htm#AEN348
[2]: https://github.com/sphinx-doc/sphinx/blob/v2.1.2/sphinx/writers/texinfo.py#L1129
* Doc: Add texinfo support to the Makefile
|
| |
|
|
|
| |
The "A4" pdfs were previously the wrong size due to a change in the options in Sphinx 1.5.
See also sphinx-doc/sphinx#5235
|
| |
|
| |
To reflect the one we're using in production.
|
| |
|
| |
Add a new pip install before `sphinx` etc.. because we should use the last version of `pip` and `setuptools`
|
| | |
|
| |
|
|
|
|
|
|
| |
(#12385)
* bpo-36329: Declare the version of Python to use for Tools/scripts/serve.py
* Add the blurb entry
|
| | |
|
| | |
|
| | |
|
| |
|
|
|
|
| |
running make (GH-4346)" (#4592)
Fix breakage documented in bpo-32149.
This reverts commit d8d6b9122134f040cd5a4f15f40f6c9e3386db4d.
|
| |
|
|
| |
(GH-4346)
|
| |
|
|
| |
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.
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* Doc: Indicate the language
* Renaming version_switcher to switchers (to add language_switcher).
* Adding language switch.
* Doc switchers: Enhance readability of regex parsing versions.
* Doc switchers: Desambiguate the need of a replace(/\/+$/g, '') by proper naming.
* Doc switchers: py3k can't reach js, it's redirected server-side by nginx.
* Doc switchers: Examples matching actual regexes.
* Doc switchers: Better fallback on unexisting translated version.
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
* bpo-30052: Always regenerate cross-references
The patch for bpo-30052 changed the preferred link target
for :func:`bytes` and :func`bytearray` references to be the
respective type definitions rather than the corresponding
builtin function entries.
This patch changes the daily documentation builds to disable
the output caching in Sphinx, in order to ensure that
cross-reference changes like this one are reliably picked
up and applied automatically after merging.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* 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
|
| |
|
|
|
|
| |
rstlint.py run by "make check" doesn't support Python 2.
"make venv" runs "$(PYTHON) -m venv", whereas Python 2 doens't
provide the venv module: it's a module of Python 3 standard library.
|
| |
|
|
| |
* Fix some deprecation warnings in Doc/conf.py
* Fix an rst error in Misc/NEWS
|
| |
|
|
| |
Patch written by Julien Palard.
|
| |\ |
|
| | |\ |
|
| | | | |
|
| |/ / |
|
| | | |
|
| |\ \
| |/ |
|
| | | |
|
| | |
| |
| |
| | |
nested subdirectory anymore.
|
