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
e8165d47b8
gh-97607: Fix content parsing in the impl-detail reST directive ( #97652 )
...
* Don't parse content as arg in the impl-detail directive
This does not change the (untranslated) output,
but ensures that the doctree node metadata is correct.
which fixes gh-97607 with the text not being translated.
It also simplifies the code and logic
and makes it consistant with the docutils built-in directives.
* Remove unused branch from impl-detail directive handling no-content case
This is not used anywhere in the docs and lacks a clear use case,
and is more likely a mistake which is now flagged at build time.
This simplifies the logic from two code paths to one,
and makes the behavior consistant with similar built-in directives
(e.g. the various admonition types).
* Further simplify impl-detail reST directive code
2022-10-02 07:20:17 +02:00
e3b6ff19aa
gh-95451: Update docs for wasm32-emscripten and -wasi platforms (GH-95452)
...
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Michael Droettboom <mdboom@gmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-08-02 21:00:41 +02:00
f81a6c5fc7
gh-95415: Make availability directive consistent (GH-95416)
2022-07-29 16:42:09 +02:00
595baa4e06
gh-86404: [doc] Two 'make suspicious' false positives. (GH-94407)
2022-06-29 10:18:54 +02:00
47e35625ff
gh-84623: Remove unused imports ( #94132 )
2022-06-22 19:14:27 +02:00
830513754d
gh-93675: Fix typos in `Doc/` (GH-93676)
...
Closes #93675
2022-06-21 21:10:45 +02:00
f62ff97f31
gh-93851: Fix all broken links in Doc/ (GH-93853)
2022-06-21 20:55:18 +02:00
0efe3a1636
gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)
...
* Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)"
This reverts commit 5c1f15b4b1b63a620014
2022-06-21 17:04:46 +02:00
bc3b31ea77
gh-86404: [doc] A make sucpicious false positive. (GH-93710)
2022-06-11 12:52:25 +02:00
45e1721d10
gh-92448: Update the documentation builder to render the GitHub issue. (GH-92449)
2022-05-08 21:50:40 +09:00
09f0ad48ef
Update the SOURCE_URI in pyspecific.py to point to the new branch
2022-05-08 03:48:31 +01:00
8d32a5c8c4
Update the SOURCE_URI in pyspecific.py to point to the new branch
2022-05-06 23:56:26 +01:00
f7641a2ffe
gh-91888: add a `:gh:` role to the documentation ( #91889 )
...
* Add a new :gh:`...` role for GitHub issues.
* Fix a GitHub id to use the :gh: role.
* Add Misc/NEWS entry.
* Refactoring and rephrasing.
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-04-25 12:05:54 +02:00
17dbb6bc10
Add redirects to Misc/NEWS bpo links ( #91454 )
2022-04-14 16:06:01 +02:00
08cfe07950
Update Sphinx bpo role to use redirect URI. ( #32342 )
2022-04-11 17:59:35 +02:00
d79f118d04
bpo-47115: Document which parts of structs are in limited API/stable ABI (GH-32196)
...
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-04-06 16:50:45 +02:00
d0e696e05d
bpo-42238: [doc]: A make sucpicious false positive. (GH-32329)
2022-04-05 09:57:42 +02:00
bdc4974965
bpo-42238: [doc]: make suspicious: false positive. (GH-32292)
2022-04-03 22:08:29 +02:00
6881ea936e
bpo-47126: Update to canonical PEP URLs specified by PEP 676 (GH-32124)
2022-03-30 12:00:27 +01:00
fe010605f8
bpo-47086: Remove dead link to old CHM documentation (GH-32075)
2022-03-23 16:13:55 +00:00
ec8906fb59
bpo-42238: [doc] Some lines moved in rst, but had hardcoded lineno in susp-ignored.csv. (GH-32070)
2022-03-23 09:34:30 +01:00
f1683173aa
[doc] Some more make suspicious false positives. (GH-31977)
2022-03-18 14:48:58 +01:00
b878b3af0b
bpo-42238: [doc] moving from rstlint.py to sphinx-lint. (GH-31097)
2022-02-10 08:59:04 +01:00
44afdbd5af
bpo-42238: [doc] Avoid hardcoding fast-moving lines in susp-ignored.csv. (GH-30981)
2022-01-28 10:50:58 +01:00
bcafab849e
[doc]: Spotted errors while working on rstlint. (GH-30879)
...
Also ignored some `make suspicious` false positives while assuring
true positives were properly seen by rstlint.
2022-01-27 08:57:43 +01:00
57d1855682
bpo-46463: Fixes escape4chm.py script used when building the CHM documentation file (GH-30768)
2022-01-21 21:51:15 +00:00
e09d94a140
bpo-46231: Remove invalid_* rules preceded by more tokens from the grammar docs (GH-30341)
2022-01-04 10:42:15 +00:00
3ea574f35b
Fix some false positives of documentation syntax problems
2021-12-08 22:22:55 +00:00
d32316a2aa
bpo-42238: [doc]: Hide false positive in make suspicious. (GH-29636)
2021-11-19 19:11:24 +01:00
bda69abe84
[doc]: Fix missing space in c-api/init.rst and add rstlint rule (GH-28988)
2021-10-19 21:13:24 +02:00
9fa930dd48
[doc]: update susp-ignored.csv after a98b273c. (GH-28827)
2021-10-09 10:25:00 +02:00
241bda785a
[doc] Fix typos found using codespell (GH-28744)
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-10-05 23:48:44 +02:00
37272f5800
bpo-42238: [doc] remove unused, and deduplicate, suspicious ignore rules. (GH-28137)
2021-09-06 08:50:48 +02:00
21fa854792
bpo-42238: [doc] Some more make suspicious false positives. (GH-27945)
2021-08-26 10:45:01 +02:00
7cba23164c
bpo-39452: Rewrite and expand __main__.rst ( #26883 )
...
Broadened scope of the document to explicitly discuss and differentiate between ``__main__.py`` in packages versus the ``__name__ == '__main__'`` expression (and the idioms that surround it), as well as ``import __main__``.
Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
Co-authored-by: Éric Araujo <merwok@netwok.org>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-08-24 19:01:41 +02:00
08830a4f75
bpo-42560: rewrite of Tkinter docs "life preserver" (GH-27842)
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-08-23 20:30:53 +02:00
058fb35b57
bpo-44854: Remove trailing whitespaces (GH-27689)
2021-08-09 21:32:54 +03:00
fbf10080bb
bpo-42238: Fix small rst issue in NEWS.d/. ( #27238 )
2021-07-19 16:34:48 +02:00
af4a2dcc40
docs: add the word 'official' (GH-26849)
2021-07-08 09:58:13 -05:00
01331f1a3c
bpo-42238: rstlint: Add two new checks. (GH-26966)
2021-07-03 10:35:02 +02:00
92d1064727
bpo-44106: Improve sqlite3 example database contents (GH-26027)
2021-05-19 10:41:19 +03:00
b05955d6f5
bpo-43795: PEP 652 user documentation (GH-25668)
...
- Reformat the C API and ABI Versioning page (and extend/clarify a bit)
- Rewrite the stable ABI docs into a general text on C API Compatibility
- Add a list of Limited API contents, and notes for the individual items.
- Replace `Include/README.rst` with a link to a devguide page with the same info
2021-05-11 07:04:33 -07:00
873275e64a
Update references to master to point to main in customsourcelink.html (GH-25993)
2021-05-08 17:13:24 +01:00
c40ab5b699
Update the SOURCE_URI in pyspecific.py to point to the new branch (GH-25977)
2021-05-08 03:43:23 +01:00
60ce8f0be6
bpo-36384: Leading zeros in IPv4 addresses are no longer tolerated (GH-25099)
...
Reverts commit e653d4d8e8
2021-05-02 14:00:35 +02:00
99fdd78200
bpo-43766: Fix TypeGuard docs ( #25660 )
2021-04-27 08:55:08 -07:00
f5c5c0c362
Fix type group capture in the PEG highlight tool (GH-25464)
2021-04-18 00:18:13 +01:00
62ec638648
bpo-43862: Enhance -W cmdline option documentation (GH-25439)
...
The -W format is "action:message:category:module:lineno".
Update also the Python manual page.
2021-04-16 19:12:14 +02:00
3386ca0b36
bpo-20364: Improve sqlite3 placeholder docs (GH-25003)
2021-04-14 15:28:55 +03:00
Julien Palard
C.A.M. Gerlach
Christian Heimes
Victor Stinner
luzpaz
Oleg Iarygin
Adam Turner
Dong-hee Na
Pablo Galindo
Ezio Melotti
Petr Viktorin
Hugo van Kemenade
Steve Dower
Christian Clauss
Jack DeVries
Mark Roseman
Serhiy Storchaka
Ned Batchelder
Erlend Egeberg Aasland
Ken Jin