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
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
Adam Turner
ae4788809d
GH-121970: Extract `misc_news` into a new extension ( #129577 )
2025-02-02 16:17:02 +00:00
Adam Turner
0612a89ffc
gh-126609: Allow translating the `availability` directive ( #129549 )
2025-02-02 16:12:01 +00:00
Adam Turner
0ef8d470b7
GH-121970: Remove pyspecific `PyDecoratorMixin` patches ( #129306 )
2025-01-26 03:43:23 +00:00
Adam Turner
d40692db06
GH-125722: Remove Sphinx patches ( #129277 )
2025-01-25 03:47:55 +00:00
Adam Turner
01bcf13a1c
GH-121970: Extract `pydoc_topics` into a new extension ( #129116 )
2025-01-21 23:28:32 +00:00
Adam Turner
e54ac3b69e
GH-121970: Extract `changes` into a new extension ( #129105 )
2025-01-20 23:53:08 +00:00
Adam Turner
d46b577ec0
GH-125722: Increase minimum supported Sphinx to 8.1.3 ( #128922 )
2025-01-20 00:26:24 +00:00
Hugo van Kemenade
c9d2bc6d7f
Revert "Doc: Show object descriptions in the table of contents ( #125757 )" ( #128406 )
2025-01-02 14:35:00 +00:00
Adam Turner
91ddde4af0
Doc: Show object descriptions in the table of contents ( #125757 )
2024-10-22 14:07:09 +01:00
Adam Turner
cbfd392479
GH-121970: Extract `availability` into a new extension ( #125082 )
2024-10-09 21:50:03 +01:00
Emily Morehouse
447a15190d
gh-125072: Add label for assignment expressions; update tracked section for assignment expression topic ( #125074 )
2024-10-07 22:51:14 +00:00
Adam Turner
91e64be731
Doc: Fix archive filenames for standard builds ( #124826 )
2024-10-01 10:43:55 +01:00
Petr Viktorin
e349f73a5a
gh-121277: Raise nice error on next as second argument to deprecated-removed (GH-124623)
2024-09-27 19:38:40 +02:00
Petr Viktorin
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
Adam Turner
6318ffcba2
Doc: Use `major.minor` for documentation distribution archive filenames ( #124489 )
2024-09-25 20:06:54 +01:00
Alex Waygood
8a2baedc4b
Bump Ruff to 0.6.7 ( #124384 )
2024-09-23 22:19:35 +00:00
Adam Turner
95f5c89b54
GH-121970: Fix `gettext` for audit events ( #122651 )
2024-08-03 17:41:26 +01:00
Adam Turner
11ad731f4f
GH-121970: Extract `audit_events` into a new extension ( #122325 )
2024-07-30 03:49:00 +00:00
Adam Turner
53e9e7de63
GH-121970: Remove `escape4chm` ( #122065 )
2024-07-23 13:30:06 +01:00
Adam Turner
8db5f48007
Docs: Fix duplicate object description warnings ( #122068 )
2024-07-20 19:46:41 +00:00
Adam Turner
b7ad711fcb
GH-121970: Modernise the patchlevel extension ( #121995 )
2024-07-20 13:44:43 +00:00
Adam Turner
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
Adam Turner
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
Adam Turner
898e90c3be
GH-121970: Make `DeprecatedRemoved a subclass of VersionChange` ( #121971 )
2024-07-19 11:39:51 +01:00
Adam Turner
adf0b94d1c
GH-121970: Improve the glossary preview in HTML search ( #121991 )
2024-07-19 10:16:59 +01:00
Adam Turner
ac39151a09
GH-121970: Use `SphinxDirective instead of Directive` ( #121972 )
2024-07-19 08:33:51 +01:00
Adam Turner
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
Petr Viktorin
48f21b3631
gh-118235: Move RAISE_SYNTAX_ERROR actions to invalid rules and make sure they stay there (GH-119731)
...
The Full Grammar specification in the docs omits rule actions, so grammar rules that raise a syntax error looked like valid syntax.
This was solved in ef940de
2024-05-30 09:27:32 +02:00
Carlos Meza
0867bce457
gh-119317: findall instead of traverse for docutils nodes ( #119319 )
2024-05-24 05:04:12 +03:00
Nice Zombies
7e894c2f38
Docs: Fix SOURCE_URI ( #118945 )
2024-05-11 05:47:45 -06:00
Inada Naoki
7ac933e260
gh-118689: Doc: fix ePub build ( #118690 )
2024-05-10 19:24:02 +09:00
Thomas Wouters
2268289a47
Python 3.13.0b1
2024-05-08 11:21:00 +02:00
Kirill Podoprigora
463c20dae9
gh-117928: Bump the minimum Sphinx version to 6.2.1 ( #117853 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-04-26 13:10:16 +03:00
Petr Viktorin
ef940dec40
gh-118235: Skip RAISE_SYNTAX_ERROR rules in the grammar spec (GH-118237)
2024-04-26 11:01:30 +02:00
Hugo van Kemenade
3284b84c43
Docs: Add classes to C API return value annotations ( #117926 )
...
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-04-16 15:56:15 +00:00
Hugo van Kemenade
3375282bb8
Docs: add link roles with Sphinx extlinks ( #117850 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-04-15 21:22:00 +03:00
Russell Keith-Magee
0f27672c50
gh-114099: Add documentation for iOS platform (GH-117057)
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Malcolm Smith <smith@chaquo.com>
Co-authored-by: Ned Deily <nad@python.org>
2024-03-28 04:13:13 -04:00
Russell Keith-Magee
408e127159
gh-114099 - Add iOS framework loading machinery. (GH-116454)
...
Co-authored-by: Malcolm Smith <smith@chaquo.com>
Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
2024-03-19 08:36:19 -04:00
Kuan-Wei Chiu
1d6989f9b0
Fix typo in c_annotations.py comment ( #108773 )
...
"compatability" => "compatibility"
2024-01-16 23:36:01 +01:00
William Andrea
f3d5d4aa8f
Docs: Link tokens in the format string grammars ( #108184 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-01-09 02:47:59 +00:00
Ege Akman
ea978c645e
gh-113637: Let c_annotations.py to handle the spacing of Limited/Unstable API & Stable ABI translation strings ( #113638 )
2024-01-03 13:22:38 +02:00
Adam Turner
9cdf05bc28
GH-101986: Support translation for Limited/Unstable API & Stable ABI ( #107680 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-10 12:17:07 -07:00
Samuel Thibault
0802fd6c8e
gh-81925: Implement native thread ids for kFreeBSD ( #111761 )
...
---------
Co-authored-by: Antoine Pitrou <antoine@python.org>
2023-11-09 21:02:30 +01:00
Tian Gao
1991694117
GH-103082: Clean up the sys.monitoring docs (GH-110532)
2023-10-18 16:15:42 -07:00
