Commit graph

415 commits

Author SHA1 Message Date
Miss Islington (bot)
87b712228e
[3.12] gh-127356: Fix prepend doctrees directory for gettext target (GH-127357) (#127471)
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-12-01 09:24:18 +00:00
Miss Islington (bot)
cb98122df2
[3.12] Update docs 'make serve' to suggest 'make htmllive' (GH-126969) (#127016)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-11-19 17:41:41 +02:00
Miss Islington (bot)
9547d2a366
[3.12] Doc: Fix archive filenames for standard builds (GH-124826) (#124837)
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-01 09:50:59 +00:00
Miss Islington (bot)
3b20c4a837
[3.12] Doc: Run HTML and non-HTML daily builds separately (GH-124493) (#124791)
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 16:55:15 +00:00
Miss Islington (bot)
db48e8f84d
[3.12] Doc: Add `make dist-no-html` (GH-124383) (#124388) 2024-09-23 23:19:18 +01:00
Miss Islington (bot)
533b06c118
[3.12] Fix doctrees directory for the gettext builder (GH-122997) (#124339)
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 14:37:10 +00:00
Miss Islington (bot)
2216c52828
[3.12] Fix make htmllive target (GH-124222)
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)

Authored-by: Zachary Ware <zach@python.org>
2024-09-18 16:12:17 -05:00
Miss Islington (bot)
f3c1f3d5ff
[3.12] Docs: Drop letter PDF (GH-123912) (#123999)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-09-16 16:08:02 +03:00
Miss Islington (bot)
53a5576ec5
[3.12] Docs: Fix Makefile syntax (GH-123287) (#123289)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-08-24 18:29:21 +03:00
Miss Islington (bot)
e9d1bf353c
[3.12] Docs: Run `latexmk` in parallel when creating PDFs (GH-123113) (#123116)
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:04:34 +00:00
Miss Islington (bot)
f7ae2c1f2a
[3.12] gh-122661: Remove GNU make-specific directive from Doc/Makefile (GH-122662) (#122669)
Co-authored-by: Libor Martínek <libas@acco.cz>
2024-08-04 17:24:57 +03:00
Hugo van Kemenade
4e47f8ad6d
[3.12] Docs makefile/RTD: Use uv if installed (GH-120711) (#120923) 2024-06-23 19:47:59 +00:00
Miss Islington (bot)
e658d87ad4
[3.12] Docs: Only install sphinx-autobuild for make htmllive (GH-119607) (#119622)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-05-27 17:35:57 +00:00
Miss Islington (bot)
ed395f5c0e
[3.12] gh-119009: Add gettext target (GH-119006) (#119075)
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-05-15 18:20:41 +00:00
Miss Islington (bot)
afe5e46a4e
[3.12] docs: announce venv creation before installing packages (GH-117036) (#117040)
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-03-19 20:04:46 +00:00
Miss Islington (bot)
f445aeac26
[3.12] Docs: make htmllive: open browser when ready (GH-113288) (#113484)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-26 12:08:43 +00:00
Miss Islington (bot)
a1447af69c
[3.12] Docs: Add make htmllive to rebuild and reload HTML files in your browser (GH-111900) (#112022)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-11-13 10:15:11 +02:00
Miss Islington (bot)
c8bffd1667
[3.12] Remove unused SPHINXLINT var from Doc/Makefile. (GH-110570) (#110585)
Remove unused `SPHINXLINT` var from `Doc/Makefile`. (GH-110570)

Remove unused `SPHINXLINT` var.
(cherry picked from commit bdbe43c7d0)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-10-10 03:14:00 +02:00
Miss Islington (bot)
6baddd9fb2
[3.12] Docs: move sphinx-lint to pre-commit (GH-105750) (#105894)
Docs: move sphinx-lint to pre-commit (GH-105750)
(cherry picked from commit bc07c8f096)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-06-18 13:21:34 +01: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
Jean-François B
b5381f6697 bpo-34293: Fix PDF documentation paper size (GH-8585)
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
2019-09-09 22:52:03 +01:00
Julien Palard
7d23dbe6d1
Doc: Bump Sphinx verison. (#13785)
To reflect the one we're using in production.
2019-06-15 15:41:58 +02:00
Stéphane Wirtel
0a52d73dde Doc: Update pip and setuptools when creating the virtual environment (GH-13307)
Add a new pip install before `sphinx` etc.. because we should use the last version of `pip` and `setuptools`
2019-05-14 04:49:49 -07:00
Gregory P. Smith
3918ad6b45
bpo-36838: Suggest 'make venv' when missing Doc/ tools. (GH-13173) 2019-05-07 17:03:50 -04:00
Stéphane Wirtel
09a9f1799c bpo-36329: Declare the version of Python to use for Tools/scripts/serve.py (#12385)
* bpo-36329: Declare the version of Python to use for Tools/scripts/serve.py

* Add the blurb entry
2019-03-18 11:47:55 +01:00
Julien Palard
f98c1623ec
Doc: -W flag for sphinx-build can be disabled (GH-10303) 2018-11-03 19:06:33 +01:00
Xtreak
121eb1694c bpo-34081: Fix wrong example link that was linking to distutils (GH-8248) 2018-10-21 16:54:52 +02:00
Jon Wayne Parrott
bf63e8d55f bpo-30607: Use external python-doc-theme (GH-2017) 2018-03-01 16:02:50 -05:00