7cc99a54b7
gh-101100: Fix sphinx warnings in library/asyncio-subprocess.rst ( #130994 )
2025-03-10 12:38:08 +00:00
a105f99019
gh-101100: Fix sphinx warnings in library/email.errors.rst ( #130774 )
2025-03-03 11:56:45 +02:00
373eb1b47a
gh-101100: Fix Sphinx documentation warnings in collections.rst ( #130629 )
2025-03-03 11:46:38 +02:00
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
3f3e1c4095
Doc: Strip trailing whitespace in `pydoc_topics` ( #130492 )
2025-02-26 20:10:55 +00:00
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
30e892473e
GH-121970: Replace custom abstract method directive with the `:abstract:` option ( #129311 )
2025-02-22 01:53:57 +00:00
3bda821a83
gh-101100: Fix sphinx warnings in readline.rst ( #130300 )
2025-02-20 14:56:27 +02:00
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
4d56c40440
GH-121970: Extract `implementation_detail` into a new extension ( #129663 )
2025-02-06 16:53:27 +00:00
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
ae4788809d
GH-121970: Extract `misc_news` into a new extension ( #129577 )
2025-02-02 16:17:02 +00:00
0612a89ffc
gh-126609: Allow translating the `availability` directive ( #129549 )
2025-02-02 16:12:01 +00:00
0ef8d470b7
GH-121970: Remove pyspecific `PyDecoratorMixin` patches ( #129306 )
2025-01-26 03:43:23 +00:00
d40692db06
GH-125722: Remove Sphinx patches ( #129277 )
2025-01-25 03:47:55 +00:00
01bcf13a1c
GH-121970: Extract `pydoc_topics` into a new extension ( #129116 )
2025-01-21 23:28:32 +00:00
e54ac3b69e
GH-121970: Extract `changes` into a new extension ( #129105 )
2025-01-20 23:53:08 +00:00
e1fa2fcc7c
gh-129044: Update glossary entry for 'loader' to reflect current import system ( #129073 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2025-01-20 15:46:09 +00:00
d46b577ec0
GH-125722: Increase minimum supported Sphinx to 8.1.3 ( #128922 )
2025-01-20 00:26:24 +00:00
3b231be8f0
Docs: fix MessageDefect references in email.policy docs ( #128468 )
2025-01-05 22:58:31 +01:00
c9d2bc6d7f
Revert "Doc: Show object descriptions in the table of contents ( #125757 )" ( #128406 )
2025-01-02 14:35:00 +00:00
8dbdbad6e0
gh-101100: Fix sphinx warnings in whatsnew/3.0.rst ( #127662 )
2024-12-10 12:22:37 +02:00
3e812253ab
gh-101100: Fix Sphinx warnings about list methods ( #127054 )
2024-12-02 15:51:35 +02:00
733fe59206
gh-101100: Fix sphinx warnings in howto/* ( #127084 )
2024-11-26 10:17:54 +02:00
1306f33c84
gh-125933: Add ARIA labels to select elements in the version switcher ( #125934 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com >
2024-10-24 23:52:21 +03:00
5003ad5c5e
gh-125909: Avoid a redirect when linking to the devguide ( #125826 )
2024-10-24 17:41:01 +01:00
91ddde4af0
Doc: Show object descriptions in the table of contents ( #125757 )
2024-10-22 14:07:09 +01:00
cbfd392479
GH-121970: Extract `availability` into a new extension ( #125082 )
2024-10-09 21:50:03 +01:00
447a15190d
gh-125072: Add label for assignment expressions; update tracked section for assignment expression topic ( #125074 )
2024-10-07 22:51:14 +00:00
91e64be731
Doc: Fix archive filenames for standard builds ( #124826 )
2024-10-01 10:43:55 +01:00
e349f73a5a
gh-121277: Raise nice error on next as second argument to deprecated-removed (GH-124623)
2024-09-27 19:38:40 +02:00
2c472d36b7
Doc: Use the short version for daily downloads ( #124602 )
2024-09-26 16:44:25 +01:00
7d24ea9db3
gh-121277: Allow .. versionadded:: next in docs (GH-121278)
...
Make `versionchanged:: next`` expand to current (unreleased) version.
When a new CPython release is cut, the release manager will replace
all such occurences of "next" with the just-released version.
(See the issue for release-tools and devguide PRs.)
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-25 23:30:40 +02:00
6318ffcba2
Doc: Use `major.minor` for documentation distribution archive filenames ( #124489 )
2024-09-25 20:06:54 +01:00
8a2baedc4b
Bump Ruff to 0.6.7 ( #124384 )
2024-09-23 22:19:35 +00:00
0060486862
Doc: Add `make dist-no-html` ( #124383 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com >
2024-09-23 23:11:34 +01:00
f5597dbd0e
Docs: Drop letter PDF ( #123912 )
2024-09-12 13:49:19 +03:00
95f5c89b54
GH-121970: Fix `gettext` for audit events ( #122651 )
2024-08-03 17:41:26 +01:00
58ffc4cf4a
gh-122384: Mark strings from Download page for translation ( #122385 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com >
2024-08-01 12:25:16 +03:00
11ad731f4f
GH-121970: Extract `audit_events` into a new extension ( #122325 )
2024-07-30 03:49:00 +00:00
aa449cf063
gh-122085: Create dedicated page for deprecations ( #122352 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2024-07-28 10:53:21 +03:00
53e9e7de63
GH-121970: Remove `escape4chm` ( #122065 )
2024-07-23 13:30:06 +01:00
8db5f48007
Docs: Fix duplicate object description warnings ( #122068 )
2024-07-20 19:46:41 +00:00
b7ad711fcb
GH-121970: Modernise the patchlevel extension ( #121995 )
2024-07-20 13:44:43 +00:00
22c9d9c1fc
GH-121970: Rewrite the C-API annotations extension ( #121985 )
...
Co-authored-by: Petr Viktorin <encukou@gmail.com >
2024-07-19 12:21:56 +00:00
40855f3ab8
GH-121970: Use Ruff to check and format the docs tools ( #122018 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@gmail.com >
2024-07-19 11:48:53 +00:00
898e90c3be
GH-121970: Make `DeprecatedRemoved a subclass of VersionChange` ( #121971 )
2024-07-19 11:39:51 +01:00
adf0b94d1c
GH-121970: Improve the glossary preview in HTML search ( #121991 )
2024-07-19 10:16:59 +01:00
ac39151a09
GH-121970: Use `SphinxDirective instead of Directive` ( #121972 )
2024-07-19 08:33:51 +01:00
7431c3799e
GH-121970: Combine custom Pygments lexers into a package ( #121976 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com >
2024-07-18 18:38:29 +00:00
Yuki Kobayashi