Commit graph

1335 commits

Author SHA1 Message Date
Miss Islington (bot)
622f37f9dd
[3.14] Remove link to the PDF downloads (GH-139142) (#139426)
Remove link to the PDF downloads (GH-139142)
(cherry picked from commit 6b5f15698a)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-09-30 00:12:28 +03:00
Miss Islington (bot)
829c81ae21
[3.14] GH-101100: Remove some entries from `nitpick_ignore` (GH-138464) (#138683)
* GH-101100: Remove some entries from ``nitpick_ignore`` (GH-138464)
(cherry picked from commit 22cb9ba8f9)

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

* Update check-warnings.py

---------

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-09-09 19:12:40 +03:00
Miss Islington (bot)
dee3428120
[3.14] gh-101100: Resolve reference warnings in reference/ (GH-138418) (#138680)
gh-101100: Resolve reference warnings in reference/ (GH-138418)
(cherry picked from commit 6831634eb7)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-09-09 19:11:09 +03:00
Miss Islington (bot)
460265fe96
[3.14] GH-101100: Resolve reference warnings in using/windows.rst (GH-138416) (#138461)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-09-04 15:44:14 +03:00
Miss Islington (bot)
2583646288
[3.14] GH-101100: Resolve reference warnings in whatsnew/3.10.rst (GH-138408) (#138480)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-09-04 12:56:52 +03:00
Miss Islington (bot)
d7c5aa992e
[3.14] GH-101100: Resolve reference warnings in whatsnew/3.5.rst (GH-138412) (#138459)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-09-03 18:46:35 +03:00
Miss Islington (bot)
28fcdda083
[3.14] GH-101100: Resolve reference warnings in whatsnew/3.6.rst (GH-138411) (#138455)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-09-03 15:27:52 +00:00
Miss Islington (bot)
e7593c8676
[3.14] GH-101100: Resolve reference warnings in extending/extending.rst (GH-138417) (#138446)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-09-03 16:15:36 +03:00
Miss Islington (bot)
44b3940143
[3.14] GH-101100: Resolve reference warnings in whatsnew/3.4.rst (GH-138413) (#138443)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-09-03 15:08:38 +03:00
Miss Islington (bot)
d713788ad1
[3.14] GH-101100: Resolve reference warnings in whatsnew/2.7.rst (GH-138415) (#138441)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-09-03 11:39:02 +00:00
Miss Islington (bot)
1e26fd0c4b
[3.14] GH-101100: Resolve reference warnings in whatsnew/3.8.rst (GH-138409) (#138437)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-09-03 11:31:06 +00:00
Miss Islington (bot)
67b8320cef
[3.14] GH-101100: Resolve reference warnings in whatsnew/3.3.rst (GH-138414) (#138435)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-09-03 11:27:01 +00:00
Miss Islington (bot)
b0069f14af
[3.14] GH-101100: Resolve reference warnings in whatsnew/3.7.rst (GH-138410) (#138423)
GH-101100: Resolve reference warnings in whatsnew/3.7.rst (GH-138410)

Resolve reference warnings in whatsnew/3.7.rst
(cherry picked from commit dd86fb4ba5)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-09-03 06:26:29 +00:00
Miss Islington (bot)
da3850cfc2
[3.14] gh-101100: Resolve reference warnings in library/xml.sax.handler.rst (GH-136612) (#138421)
gh-101100: Resolve reference warnings in library/xml.sax.handler.rst (GH-136612)
(cherry picked from commit c22cc8fccd)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-09-03 09:17:45 +03:00
Miss Islington (bot)
5c47d72c9b
[3.14] Doc: Track file downloads via plausible (GH-138393) (#138396)
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-09-02 23:00:02 +03:00
Miss Islington (bot)
7dc669f935
[3.14] gh-136155: Docs: check for EPUB fatal errors in CI (GH-134074) (#137539)
Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-08-08 19:05:29 +03:00
Miss Islington (bot)
47a2109c1a
[3.14] Link to plaintext for "show source" links (GH-137131) (#137132)
Link to plaintext for "show source" links (GH-137131)
(cherry picked from commit 9cbf46d992)

Co-authored-by: ryan-duve <ryan-duve@users.noreply.github.com>
2025-07-27 09:54:41 +03:00
Miss Islington (bot)
bbbbb2e2d1
[3.14] Partially revert "gh-101100: Fix sphinx warnings in library/email.parser.rst (GH-136475)" (GH-136629) (#136646)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-07-14 13:19:23 +03:00
Miss Islington (bot)
d351f29ef0
[3.14] gh-101100: Fix sphinx warnings in Doc/library/platform.rst (GH-136562) (GH-136597)
(cherry picked from commit 47b01da4cc)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-07-12 18:22:51 +00:00
Miss Islington (bot)
ac807cb3a0
[3.14] gh-101100: Fix sphinx warnings in Doc/library/functools.rst (GH-136424) (GH-136552)
Add index entries and anchors for cache_info, cache_clear and register.
(cherry picked from commit 252e2f710e)

Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-07-11 17:09:22 +00:00
Miss Islington (bot)
ec15251af5
[3.14] gh-101100: Fix sphinx warnings in library/email.parser.rst (GH-136475) (#136532)
Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-07-11 09:43:52 +00:00
Miss Islington (bot)
f0e603412b
[3.14] gh-101100: Fix sphinx warnings in Doc/library/exceptions.rst (GH-136309) (#136414)
Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-07-08 12:11:28 +00:00
Miss Islington (bot)
2733b290ea
[3.14] gh-101100: Fix sphinx warnings in whatsnew/3.11.rst (GH-136402) (#136405)
Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-07-08 06:47:17 +00:00
Miss Islington (bot)
5a7d266fcb
[3.14] gh-101100: Fix Sphinx warnings in library/email.compat32-message.rst (GH-136323) (#136389)
Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
2025-07-07 19:50:56 +03:00
Miss Islington (bot)
f02be2dfe8
[3.14] gh-101100: Fix sphinx warnings in whatsnew/3.9 (GH-136163) (#136372)
Co-authored-by: sobolevn <mail@sobolevn.me>
2025-07-07 10:48:04 +00:00
Miss Islington (bot)
381144f043
[3.14] GH-134848: Use a set to store `AuditEvents.sources` (GH-134849) (#134853)
GH-134848: Use a set to store ``AuditEvents.sources`` (GH-134849)
(cherry picked from commit b265a7ddeb)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-05-28 16:37:57 +00:00
Miss Islington (bot)
d5f7e80d44
[3.14] Consistent sentence case in docs template files (GH-134412) (#134495)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-05-22 12:57:42 +03:00
Miss Islington (bot)
ff0facd332
[3.14] gh-101100: Fix Sphinx warnings in library/decimal.rst (GH-134303) (#134338)
Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
2025-05-20 14:52:11 +00:00
Miss Islington (bot)
ea15c55143
[3.14] Docs: remove link elements in builders other than HTML (GH-133720) (#134005)
Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
2025-05-14 18:22:07 +03:00
Hugo van Kemenade
5f01b00dea Python 3.14.0b1 2025-05-06 18:32:57 +03:00
Ee Durbin
1d529cbc89
Docs: Migrate entirely to PSF hosted plausible for analytics (#132648) 2025-04-17 22:42:40 +03:00
Adam Turner
4f10b93d1b
Docs: Synchronise `indexsidebar.html` with docsbuild-scripts (#132567) 2025-04-15 23:27:01 +01:00
Yuki Kobayashi
fc7e4e7bbd
gh-101100: Fix sphinx warnings in library/plistlib.rst (#132422) 2025-04-13 18:35:26 +00:00
Ee Durbin
40844164b1
Add psfhosted Plausible instance to analytics (#132252) 2025-04-08 10:37:42 +03:00
Stan Ulbrych
f5639d87f5
gh-130521: Add Open Graph meta tags to template pages (#130523)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-04-07 21:58:50 +01:00
Hugo van Kemenade
ce724571b3
Docs HTML: Remove self-closing tags (#132220)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-04-07 18:21:13 +03:00
Adam Turner
443c0cd17c
gh-127833: Use productionlist nodes to implement the grammar-snippet directive (#130376)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Blaise Pabon <blaise@gmail.com>
2025-03-20 15:35:20 +00:00
Adam Turner
c1a02f9101
GH-121970: Extract pydoc_topics into a new extension (#131256) 2025-03-19 18:35:11 +00:00
Hugo van Kemenade
ca1bedc9a4
gh-121970: Revert "GH-121970: Extract `pydoc_topics` into a new extension (#129116)" (#131245)
Revert "GH-121970: Extract ``pydoc_topics`` into a new extension (#129116)"

This reverts commit 01bcf13a1c.
2025-03-14 16:25:56 +02:00
Yuki Kobayashi
7cc99a54b7
gh-101100: Fix sphinx warnings in library/asyncio-subprocess.rst (#130994) 2025-03-10 12:38:08 +00:00
Yuki Kobayashi
a105f99019
gh-101100: Fix sphinx warnings in library/email.errors.rst (#130774) 2025-03-03 11:56:45 +02:00
Victorien
373eb1b47a
gh-101100: Fix Sphinx documentation warnings in collections.rst (#130629) 2025-03-03 11:46:38 +02:00
Adam Turner
043ab3af9a
GH-121970: Extract `issue_role` into a new extension (#130615)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-02-27 19:06:13 +00:00
Adam Turner
3f3e1c4095
Doc: Strip trailing whitespace in `pydoc_topics` (#130492) 2025-02-26 20:10:55 +00:00
sobolevn
5ec4bf86b7
gh-121970: Replace .. coroutine{method,function} with :async: (#130448)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-02-22 17:54:43 +00:00
Adam Turner
30e892473e
GH-121970: Replace custom abstract method directive with the `:abstract:` option (#129311) 2025-02-22 01:53:57 +00:00
Yuki Kobayashi
3bda821a83
gh-101100: Fix sphinx warnings in readline.rst (#130300) 2025-02-20 14:56:27 +02:00
Yuki Kobayashi
1da412e574
gh-101100: Docs: Fix some typos in the document (#129988)
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2025-02-11 13:06:32 +02:00
Adam Turner
4d56c40440
GH-121970: Extract `implementation_detail` into a new extension (#129663) 2025-02-06 16:53:27 +00:00
Petr Viktorin
58a4357e29
gh-127833: Docs: Add a grammar-snippet directive & replace productionlist (GH-127835)
As a first step toward aligning the grammar documentation with Python's actual
grammar, this overrides the ReST `productionlist` directive to:
- use `:` instead of the `::=` symbol
- add syntax highlighting for strings (using a Pygments highlighting class)

All links and link targets should be preserved. (Unfortunately, this reaches
into some Sphinx internals; I don't see a better way to do exactly what
Sphinx does.)

This also adds a new directive, `grammar-snippet`, which formats the snippet
almost exactly like what's in the source, modulo syntax highlighting and
keeping the backtick character to mark links to other rules.
This will allow formatting the snippets as in the grammar file
(file:///home/encukou/dev/cpython/Doc/build/html/reference/grammar.html).

The new directive is applied to two simple rules in toplevel_components.rst

---------

Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: William Ferreira <wqferr@gmail.com>
Co-authored-by: bswck <bartoszpiotrslawecki@gmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-02-05 16:12:23 +01:00