summaryrefslogtreecommitdiffstats
path: root/Doc/Makefile
Commit message (Collapse)AuthorAgeFilesLines
* gh-127356: Fix prepend doctrees directory for gettext target (#127357)Rafael Fontenelle2024-12-011-1/+1
|
* Update docs 'make serve' to suggest 'make htmllive' (#126969)Hugo van Kemenade2024-11-191-1/+1
|
* Doc: Fix archive filenames for standard builds (#124826)Adam Turner2024-10-011-2/+4
|
* Doc: Run HTML and non-HTML daily builds separately (#124493)Adam Turner2024-09-301-3/+3
|
* Doc: Add ``make dist-no-html`` (#124383)Adam Turner2024-09-231-1/+31
| | | Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* Fix `make htmllive` target (GH-124219)Zachary Ware2024-09-181-1/+1
| | | | | Allow `make -C Doc htmllive` to work without manual venv activation Set PATH to ensure that `sphinx-autobuild` can find `sphinx-build`.
* Docs: Drop letter PDF (#123912)Hugo van Kemenade2024-09-121-10/+0
|
* Docs: Fix Makefile syntax (#123287)Adam Turner2024-08-241-2/+2
|
* Docs: Run ``latexmk`` in parallel when creating PDFs (#123113)Adam Turner2024-08-171-17/+32
|
* Fix doctrees directory for the gettext builder (#122997)Rafael Fontenelle2024-08-141-1/+1
|
* gh-122661: Remove GNU make-specific directive from Doc/Makefile (#122662)Libor Martínek2024-08-041-16/+20
|
* Docs makefile/RTD: Use uv if installed (#120711)Hugo van Kemenade2024-06-231-6/+19
|
* Docs: Only install sphinx-autobuild for `make htmllive` (#119607)Hugo van Kemenade2024-05-271-1/+5
|
* gh-119009: Add gettext target (#119006)Rafael Fontenelle2024-05-151-0/+6
|
* docs: announce venv creation before installing packages (#117036)Ned Batchelder2024-03-191-0/+1
|
* Docs: make htmllive: open browser when ready (#113288)Hugo van Kemenade2023-12-261-3/+7
|
* Docs: Add `make htmllive` to rebuild and reload HTML files in your browser ↵Hugo van Kemenade2023-11-131-0/+6
| | | | (#111900)
* Remove unused `SPHINXLINT` var from `Doc/Makefile`. (#110570)Ezio Melotti2023-10-091-1/+0
| | | Remove unused `SPHINXLINT` var.
* Docs: move sphinx-lint to pre-commit (#105750)Hugo van Kemenade2023-06-181-5/+3
|
* GH-103903: Test the minimum Sphinx version in CI (#103904)Adam Turner2023-04-271-2/+3
|
* Add JOBS parameter to docs Makefile (#101395)Christophe Nanteuil2023-01-311-1/+2
|
* Docs: Move .PHONY to each section to avoid copy/paste omissions (#99396)Hugo van Kemenade2022-11-271-4/+24
|
* Mark all targets in `Doc/Makefile` as `PHONY` (GH-98189)Nikita Sobolev2022-10-121-3/+3
|
* gh-86404: Doc: Drop now unused make suspicious and rstlint. (GH-98179)Julien Palard2022-10-111-14/+1
| | | | They have been replaced by [sphinx-lint](https://github.com/sphinx-contrib/sphinx-lint).
* Speedup: build docs in parallel (GH-92733)Hugo van Kemenade2022-05-161-1/+1
|
* Restore default role check in `make check`. (#92290)Ezio Melotti2022-05-151-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* bpo-36329: Remove 'make -C Doc serve' in favour of 'make -C Doc htmlview' ↵Hugo van Kemenade2022-04-291-4/+2
| | | | | | | | | | | | | | | | | | (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
* bpo-42238: [doc] moving from rstlint.py to sphinx-lint. (GH-31097)Julien Palard2022-02-101-2/+3
|
* Allows to specify the port on which serve documentation (GH-31145)Christophe Nanteuil2022-02-061-1/+2
| | | | | | | | | | [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. (GH-29652)Julien Palard2021-11-221-0/+4
| | | | | * bpo-42238: [doc] Announce the future removal of make suspicous. * Add a news entry.
* bpo-44756: [docs] revert automated virtual environment creation on `make ↵Łukasz Langa2021-08-061-2/+3
| | | | | html` (GH-27635) It turned out to be disruptive for downstream distributors.
* bpo-44756: in ./Doc, `make build` depends on `make html` (#27403)Jack DeVries2021-07-281-7/+14
| | | | - venv rule is now conditional, and only does anything if $VENVDIR does not exist - add rule "clean-venv"
* bpo-42238: Check Misc/NEWS.d/next/ for reStructuredText issues. (GH-23802)Julien Palard2020-12-181-0/+1
|
* bpo-42238: Doc: Remove make suspicious from the CI and docs builds. (GH-23313)Julien Palard2020-11-251-1/+0
| | | | | 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.
* bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969)Julien Palard2020-11-071-2/+2
|
* bpo-35293: Travis CI uses "make venv" for the doc (GH-22307)Victor Stinner2020-09-181-1/+1
| | | | | | | 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
* bpo-41685: Don't pin setuptools version anymore in Doc/Makefile (GH-22062)Victor Stinner2020-09-021-2/+1
| | | | setuptools 50.0.2 is now compatible with Python 3.10: https://github.com/pypa/setuptools/pull/2361
* bpo-40204: Update Sphinx to version 3.2.1 in Doc/Makefile (GH-22043)Victor Stinner2020-09-021-1/+1
|
* bpo-41685: Temporarily pin setuptools to 49.2.1 in Docs venv. (GH-22038)Ned Deily2020-09-011-1/+2
| | | See https://github.com/pypa/setuptools/pull/2361
* bpo-40204: Pin Sphinx version to 2.3.1 in ``Doc/Makefile``. (GH-21141)Ned Deily2020-06-251-1/+1
|
* Bump Sphinx to 2.2.0. (GH-16532)Julien Palard2019-10-221-1/+1
|
* bpo-37504: Fix documentation build with texinfo builder (GH-14606)Dmitry Shachnev2019-09-101-1/+18
| | | | | | | | | 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
* bpo-34293: Fix PDF documentation paper size (GH-8585)Jean-François B2019-09-091-1/+5
| | | | | 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
* Doc: Bump Sphinx verison. (#13785)Julien Palard2019-06-151-1/+1
| | | To reflect the one we're using in production.
* Doc: Update pip and setuptools when creating the virtual environment (GH-13307)Stéphane Wirtel2019-05-141-0/+1
| | | Add a new pip install before `sphinx` etc.. because we should use the last version of `pip` and `setuptools`
* bpo-36838: Suggest 'make venv' when missing Doc/ tools. (GH-13173)Gregory P. Smith2019-05-071-4/+12
|
* bpo-36329: Declare the version of Python to use for Tools/scripts/serve.py ↵Stéphane Wirtel2019-03-181-1/+1
| | | | | | | | (#12385) * bpo-36329: Declare the version of Python to use for Tools/scripts/serve.py * Add the blurb entry
* Doc: -W flag for sphinx-build can be disabled (GH-10303)Julien Palard2018-11-031-2/+3
|
* bpo-34081: Fix wrong example link that was linking to distutils (GH-8248)Xtreak2018-10-211-1/+1
|
* bpo-30607: Use external python-doc-theme (GH-2017)Jon Wayne Parrott2018-03-011-1/+1
|