Commit graph

423 commits

Author SHA1 Message Date
Miss Islington (bot)
0a239ddd39
[3.13] gh-145455: Show output of blurb & sphinx-build version commands (GH-145457) (GH-145462)
In gh-145455, an outdated dependency caused an import error that was not
printed out (`2>&1`); the message instead said that the tools are missing.

Don't redirect stderr, to show warnings and failures.

Also, switch `blurb` to output a version on a single line (`--version` rather
than `help`), and, and don't redirect stdout either.
This results in two version info lines being printed out. These get drowned
in typical Sphinx output, and can be helpful when debugging.
(cherry picked from commit f1de65b366)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2026-03-03 14:25:13 +01:00
Hugo van Kemenade
7dc6acc1e9
[3.13] gh-84232: Fix pydoc docs.python.org link generation (GH-139995) (#143099)
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Éric <merwok@netwok.org>
2025-12-23 18:29:28 +02:00
Miss Islington (bot)
46d96dce63
[3.13] gh-139741: Make dist-pdf docs archive build work for macOS (GH-140837) (#141230)
Co-authored-by: Naitree Zhu <Naitreey@gmail.com>
2025-11-08 10:26:51 +00:00
Miss Islington (bot)
ccf2f377fc
[3.13] gh-139436: Remove `dist-pdf` from the docs archives rebuild target (GH-139437) (#139693)
gh-139436: Remove ``dist-pdf`` from the docs archives rebuild target (GH-139437)
(cherry picked from commit 0e2cdd313b)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-10-07 19:12:31 +01:00
Miss Islington (bot)
1172f4ccfe
[3.13] gh-136854: Exit on error in make venv (GH-136856) (#136861)
Co-authored-by: Nacho Caballero <nachocab@gmail.com>
Co-authored-by: Nacho Caballero <nacho.caballero@astrazeneca.com>
2025-07-20 12:14:42 +00:00
Adam Turner
f24f241802
[3.13] Generate social media preview cards for the documentation (GH-132101) (#132344) 2025-04-10 06:39:46 +01:00
Miss Islington (bot)
2077082463
[3.13] doc: fix venv creating for the local Python using uv (GH-129094) (#129096)
Co-authored-by: Filipe Laíns 🇵🇸 <lains@riseup.net>
2025-01-20 21:13:12 +02:00
Miss Islington (bot)
59b919b082
[3.13] GH-125722: Use long options for Sphinx (GH-129039) (#129041)
GH-125722: Use long options for Sphinx (GH-129039)
(cherry picked from commit 4967fa6a9c)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-01-20 09:17:29 +02:00
Miss Islington (bot)
3b31f8c7e8
[3.13] gh-127356: Fix prepend doctrees directory for gettext target (GH-127357) (#127470)
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-12-01 09:21:34 +00:00
Miss Islington (bot)
dd222a4d47
[3.13] Update docs 'make serve' to suggest 'make htmllive' (GH-126969) (#127015)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-11-19 17:41:33 +02:00
Miss Islington (bot)
4392c5980d
[3.13] Doc: Fix archive filenames for standard builds (GH-124826) (#124836)
Doc: Fix archive filenames for standard builds (GH-124826)
(cherry picked from commit 91e64be731)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-10-03 09:19:14 -07:00
Miss Islington (bot)
bc1fae89af
[3.13] Doc: Run HTML and non-HTML daily builds separately (GH-124493) (#124790)
Doc: Run HTML and non-HTML daily builds separately (GH-124493)
(cherry picked from commit cce1125574)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-09-30 13:59:53 -07:00
Miss Islington (bot)
057f3faecf
[3.13] Fix make htmllive target (GH-124219) (#124221)
Fix `make htmllive` target (GH-124219)

Allow `make -C Doc htmllive` to work without manual venv activation

Set PATH to ensure that `sphinx-autobuild` can find `sphinx-build`.
(cherry picked from commit 9a6e2336e4)

Co-authored-by: Zachary Ware <zach@python.org>
2024-09-23 16:21:35 -07:00
Miss Islington (bot)
1503835b1b
[3.13] Fix doctrees directory for the gettext builder (GH-122997) (#124338)
Fix doctrees directory for the gettext builder (GH-122997)
(cherry picked from commit 315a933a5b)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-09-23 15:49:53 -07:00
Miss Islington (bot)
c0ce0399fd
[3.13] Doc: Add `make dist-no-html` (GH-124383) (#124387)
Doc: Add ``make dist-no-html`` (GH-124383)
(cherry picked from commit 0060486862)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-09-23 22:30:30 +00:00
Miss Islington (bot)
355dc72546
[3.13] Docs: Drop letter PDF (GH-123912) (#123998)
Docs: Drop letter PDF (GH-123912)
(cherry picked from commit f5597dbd0e)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-09-23 11:09:03 -07:00
Miss Islington (bot)
5709cee0b6
[3.13] Docs: Fix Makefile syntax (GH-123287) (#123288)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-08-25 00:03:54 +03:00
Miss Islington (bot)
b5bba3bb6c
[3.13] Docs: Run `latexmk` in parallel when creating PDFs (GH-123113) (#123115)
Docs: Run ``latexmk`` in parallel when creating PDFs (GH-123113)
(cherry picked from commit 79c542b5cc)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-08-17 21:15:24 +00:00
Miss Islington (bot)
60c44ed975
[3.13] gh-122661: Remove GNU make-specific directive from Doc/Makefile (GH-122662) (#122668)
Co-authored-by: Libor Martínek <libas@acco.cz>
2024-08-09 14:43:09 +03:00
Miss Islington (bot)
1aadb51838
[3.13] Docs makefile/RTD: Use uv if installed (GH-120711) (#120922)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-06-23 19:48:42 +00:00
Miss Islington (bot)
ba71835fa5
[3.13] Docs: Only install sphinx-autobuild for make htmllive (GH-119607) (#119621)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-05-27 17:44:55 +00:00
Miss Islington (bot)
7c224dd4cc
[3.13] gh-119009: Add gettext target (GH-119006) (#119074)
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-05-15 18:31:55 +00:00
Ned Batchelder
332ac46c09
docs: announce venv creation before installing packages (#117036) 2024-03-19 21:55:20 +02:00
Hugo van Kemenade
36adc79041
Docs: make htmllive: open browser when ready (#113288) 2023-12-26 05:02:13 -07:00
Hugo van Kemenade
a430b4ffdd
Docs: Add make htmllive to rebuild and reload HTML files in your browser (#111900) 2023-11-13 10:06:49 +02:00
Ezio Melotti
bdbe43c7d0
Remove unused SPHINXLINT var from Doc/Makefile. (#110570)
Remove unused `SPHINXLINT` var.
2023-10-10 00:30:23 +02:00
Hugo van Kemenade
bc07c8f096
Docs: move sphinx-lint to pre-commit (#105750) 2023-06-18 11:52:05 +00:00
Adam Turner
44b5c21f41
GH-103903: Test the minimum Sphinx version in CI (#103904) 2023-04-27 19:27:38 +01:00
Christophe Nanteuil
1a62ae84c6
Add JOBS parameter to docs Makefile (#101395) 2023-01-31 15:29:29 +02:00
Hugo van Kemenade
969620d59a
Docs: Move .PHONY to each section to avoid copy/paste omissions (#99396) 2022-11-27 19:48:29 +02:00
Nikita Sobolev
4414586172
Mark all targets in Doc/Makefile as PHONY (GH-98189) 2022-10-12 21:40:47 +02: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
Hugo van Kemenade
a487623c6b
Speedup: build docs in parallel (GH-92733) 2022-05-16 13:52:00 +02:00
Ezio Melotti
953ab07952
Restore default role check in make check. (#92290)
* 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>
2022-05-15 17:34:52 +02:00
Hugo van Kemenade
89c6b2b8f6
bpo-36329: Remove 'make -C Doc serve' in favour of 'make -C Doc htmlview' (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
2022-04-29 15:47:26 +02:00
Julien Palard
b878b3af0b
bpo-42238: [doc] moving from rstlint.py to sphinx-lint. (GH-31097) 2022-02-10 08:59:04 +01:00
Christophe Nanteuil
f1e29cea85
Allows to specify the port on which serve documentation (GH-31145)
[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
2022-02-06 11:22:06 +01:00
Julien Palard
024209401e
bpo-42238: [doc] Announce the future removal of make suspicous. (GH-29652)
* bpo-42238: [doc] Announce the future removal of make suspicous.

* Add a news entry.
2021-11-22 15:17:54 -08: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
b9735420aa
bpo-42238: Check Misc/NEWS.d/next/ for reStructuredText issues. (GH-23802) 2020-12-18 10:48:08 +01:00
Julien Palard
c9c6e9f89a
bpo-42238: Doc: Remove make suspicious from the CI and docs builds. (GH-23313)
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.
2020-11-25 10:18:00 +01:00
Julien Palard
ee2549c2ba
bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969) 2020-11-07 12:28:31 +01:00
Victor Stinner
8394500cca
bpo-35293: Travis CI uses "make venv" for the doc (GH-22307)
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
2020-09-18 16:23:18 +02:00
Victor Stinner
51fece1bb8
bpo-41685: Don't pin setuptools version anymore in Doc/Makefile (GH-22062)
setuptools 50.0.2 is now compatible with Python 3.10:
https://github.com/pypa/setuptools/pull/2361
2020-09-02 13:11:21 +02:00
Victor Stinner
c0d5c131d9
bpo-40204: Update Sphinx to version 3.2.1 in Doc/Makefile (GH-22043) 2020-09-02 12:29:31 +02:00
Ned Deily
a4c4e17f95
bpo-41685: Temporarily pin setuptools to 49.2.1 in Docs venv. (GH-22038)
See https://github.com/pypa/setuptools/pull/2361
2020-09-01 05:40:27 -04:00
Ned Deily
589e8fe079
bpo-40204: Pin Sphinx version to 2.3.1 in `Doc/Makefile`. (GH-21141) 2020-06-25 07:22:10 -04:00
Julien Palard
c987090c73
Bump Sphinx to 2.2.0. (GH-16532) 2019-10-22 18:13:41 +02:00
Dmitry Shachnev
c3d679fd39 bpo-37504: Fix documentation build with texinfo builder (GH-14606)
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
2019-09-10 15:40:50 +01:00