e4c0876033
gh-101100: Fix Sphinx nits in `library/contextlib.rst` ( #112870 )
2023-12-08 13:17:57 +00:00
3cdcc2edf8
gh-101100: Fix Sphinx nitpicks in `library/shelve.rst` ( #112836 )
2023-12-08 14:31:11 +02:00
2c3906bc4b
gh-101100: Silence Sphinx warnings when `ntpath` or `posixpath` are referenced ( #112833 )
2023-12-07 20:57:30 +00:00
3870d19d15
gh-101100: Fix Sphinx nitpicks in `library/reprlib.rst` ( #112811 )
2023-12-06 20:16:12 +00:00
9560e0d6d7
gh-101100: Fix Sphinx nitpicks in `library/abc.rst` ( #112703 )
2023-12-04 12:42:24 +00:00
cda737924f
gh-101100: Fix Sphinx nitpicks in `library/functions.rst` ( #112669 )
2023-12-04 11:05:20 +00:00
489aeac3a2
gh-101100: Fix Sphinx warning in `library/gettext.rst` ( #112668 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-03 20:23:09 +00:00
3faf8e586d
gh-101100: Fix Sphinx reference warnings (GH-112416)
...
* Fix Sphinx warning in library/xml.rst
Direct use of the pyexpat module is deprecated, but this is how to check the version for security purposes
* Fix Sphinx warning in library/importlib.resources.rst
* Use italics for parameters
* Link to the exception
* Fix Sphinx warning in library/gzip.rst
* Document message and header defect base classes to fix Sphinx warning in library/email.headerregistry.rst
* Restore feed_eof() doc to fix Sphinx warning in library/asyncio-stream.rst
* Fix Sphinx warning in extending/newtypes.rst
* Fix Sphinx warning in c-api/set.rst
On stdtypes.rst, set and frozenset are documented together and the frozenset has the working refs
2023-11-25 15:40:19 -08:00
0303a9fa79
gh-101100 : Fix Sphinx warnings in `library/doctest.rst` ( #112399 )
...
* Fix Sphinx warnings in library/doctest.rst
* Don't link to self, and wrap a line
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* Link to load_tests protocol
* Link to option flags
* Wrap line
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
---------
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-11-25 20:08:32 +02:00
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
6a0d7b43df
gh-111625: Fix link to Info-ZIP homepage ( #111626 )
2023-11-02 11:10:30 +00:00
46389c3275
gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` (GH-111222)
...
* gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst`
* Update Doc/library/socket.rst
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Update asyncio-eventloop.rst
* Update socket.rst
---------
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-29 12:31:01 -07:00
96cbd1e1db
gh-101100: Fix Sphinx warnings for `fileno` ( #111118 )
2023-10-23 13:05:56 -06:00
8c689c9b88
gh-101100: Fix sphinx warnings in `library/asyncio-dev.rst` (GH-111179)
...
* gh-101100: Fix sphinx warnings in `library/asyncio-dev.rst`
* Update Doc/library/asyncio-eventloop.rst
* Update Doc/library/asyncio-eventloop.rst
---------
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2023-10-22 17:11:57 +00:00
663cf513b0
gh-101100: Fix Sphinx warning in `tutorial/introduction.rst` ( #111173 )
2023-10-22 14:53:17 +03:00
c42c68aa7b
gh-101100: Fix Sphinx warnings in `library/tty.rst` ( #111079 )
...
Fix Sphinx warnings in library/tty.rst
2023-10-20 07:33:17 +03:00
d144749914
gh-101100: Fix sphinx warnings in `library/getpass.rst` ( #110461 )
2023-10-19 18:04:29 +03:00
a89708aeea
gh-101100: Fix sphinx warnings in `library/codecs.rst` ( #110979 )
2023-10-19 17:20:52 +03:00
1991694117
GH-103082: Clean up the sys.monitoring docs (GH-110532)
2023-10-18 16:15:42 -07:00
12deda7633
gh-101100: Fix sphinx warnings in `library/time.rst` ( #110862 )
2023-10-14 16:20:19 +02:00
45cfabb842
gh-101100: Fix sphinx warnings in `usage/cmdline.rst` ( #110841 )
2023-10-14 08:05:46 +02:00
b7f9661bc1
Fix the pyspecific SOURCE_URI ( #110811 )
2023-10-13 08:43:01 +00:00
756062b296
gh-101100: Fix sphinx warnings in `library/socketserver.rst` (GH-110207)
2023-10-10 13:44:19 +02:00
31097df611
gh-101100: Fix sphinx warnings in `library/site.rst` ( #110144 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-10-01 20:18:19 +03:00
8898a8683b
gh-101100: Fix Sphinx warnings in `tutorial/controlflow.rst` ( #109424 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-29 11:27:43 +03:00
d102d39bbe
gh-101100: Fix sphinx warnings in `library/difflib.rst` ( #110074 )
2023-09-29 11:03:59 +03:00
0baf72696e
gh-109961: Docs: Fix incorrect rendering of `__replace__` in `copy.rst` ( #109968 )
2023-09-28 14:51:33 +03:00
d9809e84fb
gh-101100: Fix sphinx warnings in `library/devmode.rst` ( #109963 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-27 16:07:28 +03:00
3538930d87
gh-101100: Fix Sphinx warnings in Doc/using/configure.rst ( #109931 )
2023-09-27 02:01:48 +02:00
7c61a361fc
gh-101100: Fix Sphinx warnings in `Doc/library/weakref.rst` ( #109881 )
2023-09-26 10:46:09 +03:00
f2eaa92b0c
gh-101100: Fix sphinx warnings in `Doc/library/__future__.rst` ( #109814 )
2023-09-25 00:31:56 -06:00
649768fb67
gh-101100: Fix sphinx warnings in `Doc/library/xml.etree.elementtree.rst` ( #109799 )
...
gh-101100: Fix shpinx warnings in `Doc/library/xml.etree.elementtree.rst`
2023-09-24 12:49:02 +03:00
21e80f4c19
gh-101100: Fix sphinx warnings in `turtle.rst` ( #109394 )
2023-09-14 14:24:18 -04:00
90cf345ed4
GH-104395: Add a link in 'Meta Information' to the docs download page ( #104443 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-12 20:32:13 +00:00
5141b1ebe0
gh-101100: Fix sphinx warnings in `unittest.mock-examples.rst` ( #108810 )
2023-09-02 13:05:44 +01:00
21da4980f5
gh-101100: Fix sphinx warnings in `uuid.rst` ( #108805 )
...
* gh-101100: Fix sphinx warnings in `uuid.rst`
* Use anchors
2023-09-02 09:32:19 +00:00
3047f09490
gh-101100: Fix sphinx warnings in `tutorial/appendix.rst` ( #108750 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-01 10:57:34 +00:00
e775601ef1
gh-101100: Fix sphinx warnings in `tutorial/classes.rst` ( #108746 )
2023-09-01 13:44:43 +03:00
991e4e76b5
gh-101100: Fix sphinx warnings in `threading.rst` ( #108684 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-31 10:28:27 +03:00
c7cef54631
gh-101100: Fix Sphinx warnings in the Logging Cookbook ( #108678 )
2023-08-30 14:37:45 +03:00
cb1184280b
Docs: Resolve Sphinx warnings in dis.rst ( #108476 )
...
- Link to the code objects reference
- Suppress link to deliberately undocumented builtins.__build_class__
- Suppress links for example methods
2023-08-25 13:28:47 +02:00
fc23f34cc9
gh-107136: Remove Plausible for docs metrics ( #107856 )
2023-08-22 20:45:22 +02:00
d7202e4879
gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258)
2023-08-22 15:50:30 +03:00
d63972e289
gh-107298: Fix C API datetime documentation (GH-108034)
2023-08-21 21:15:46 +03:00
622ddc4167
Improve references in the tutorial (GH-108069)
...
* Use full qualified names for references (even if they do not work now,
they will work in future).
* Silence references to examples.
2023-08-21 13:41:01 +03:00
8f3d09bf5d
Resolve reference warnings in faq/gui.rst ( #108147 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-21 07:37:52 +00:00
6323bc33ff
Resolve reference warnings in faq/library.rst ( #108149 )
...
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-20 19:01:13 +00:00
92815cc7cf
Resolve reference warnings in faq/design.rst ( #108148 )
2023-08-20 12:34:27 -06:00
a390ec20f5
Resolve reference warnings in faq/programming.rst ( #108150 )
2023-08-20 19:23:28 +05:30
c735e79afb
Docs: Fix Sphinx warnings in logging.rst (GH-108139)
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-20 12:19:07 +01:00
4d4393139f
Docs: Fix Sphinx warnings in license.rst ( #108142 )
...
- Fix links to stdlib modules
- Silence links to external functions
2023-08-20 13:10:48 +02:00
29fa7afef9
Docs: Fix Sphinx warnings in sys.rst ( #108106 )
...
- Mark up named tuple attributes as attributes
- Remove links for external functions
- io.BufferedIOBase has no 'buffer' attribute;
remove the link and mark up using :attr:`!buffer`
- (Re)format some tables as bullet lists:
- sys._emscripten_info
- sys.hash_info
- sys.int_info
- sys.thread_info
- In the paragraphs mentioning 'f_trace_lines' and 'f_trace_opcodes',
add links to the frame objects reference.
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-20 13:09:33 +02:00
eb953d6e44
gh-101100: Only show GitHub check annotations on changed doc paragraphs ( #108065 )
...
* Only show GitHub check annotations on changed doc paragraphs
* Improve check-warnings script arg parsing following Hugo's suggestions
* Factor filtering warnings by modified diffs into helper function
* Build docs on unmerged branch so warning lines match & avoid deep clone
---------
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-18 19:43:28 -05:00
5c76899dad
Docs: Fix Sphinx warnings in io.rst ( #107903 )
...
- Mark up parameter and argument names properly
- If possible, link to docs for methods like `seek`, `tell`, `write`, `read`, etc.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-17 19:19:01 +00:00
c2941cba7a
gh-107298: Fix C API Buffer documentation ( #108011 )
2023-08-16 18:24:46 +02:00
8c9af6b9a0
Docs: Fix more Sphinx annotations in ctypes.rst ( #107708 )
2023-08-07 15:11:05 +02:00
9564e31cbc
Do not use deprecated ``logger.warn()`` in pyspecific ( #107694 )
2023-08-06 13:58:00 +00:00
ecb05e0b98
GH-84435: Make pyspecific directives translatable ( #19470 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-05 23:10:50 -06:00
904b5319b3
Docs: Only include Plausible for html, not for epub etc ( #107637 )
...
Only include Plausible for html, not for epub etc
2023-08-04 21:33:34 +03:00
f2d07d3289
gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386)
2023-07-29 08:48:10 +03:00
0aa58fa7a6
gh-107091: Fix some uses of :const: role (GH-107379)
...
It is for references, not for literals.
2023-07-28 13:26:28 +03:00
983305268e
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
abec9a1b20
gh-107298: Docs: add targets for some :c:member: and :c:macro: references (GH-107316)
...
Add targets for PyStructSequence_Desc and PyStructSequence_Field members
and macros like Py_EQ.
Fix target for Py_RETURN_RICHCOMPARE.
2023-07-27 09:04:02 +03:00
d363eb5b02
gh-107091: Fix some uses of :attr: role (GH-107318)
...
Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
8d61a71f9c
gh-107298: Fix more Sphinx warnings in the C API doc ( #107329 )
...
Declare the following functions as macros, since they are actually
macros. It avoids a warning on "TYPE" or "macro" argument.
* PyMem_New()
* PyMem_Resize()
* PyModule_AddIntMacro()
* PyModule_AddStringMacro()
* PyObject_GC_New()
* PyObject_GC_NewVar()
* PyObject_New()
* PyObject_NewVar()
Add C standard C types to nitpick_ignore in Doc/conf.py:
* int64_t
* uint64_t
* uintptr_t
No longer ignore non existing "__int" type in nitpick_ignore.
Update Doc/tools/.nitignore
2023-07-27 00:52:40 +00:00
391e03fa05
gh-107298: Fix Sphinx warnings in the C API doc ( #107302 )
...
* Update Doc/tools/.nitignore
* Fix BufferedIOBase.write() link in buffer.rst
2023-07-27 01:41:15 +02:00
87b39028e5
gh-107298: Fix doc references to undocumented modules ( #107300 )
...
Update also Doc/tools/.nitignore.
2023-07-26 18:59:06 +02:00
b1de3807b8
gh-106948: Update documentation nitpick_ignore for c:identifer domain ( #107295 )
...
Update the nitpick_ignore of the documentation configuration to fix
Sphinx warnings about standard C types when declaring functions with
the "c:function" markups.
Copy standard C types declared in the "c:type" domain to the
"c:identifier" domain, since "c:function" markup looks for types in
the "c:identifier" domain.
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-26 18:04:46 +02:00
b447e19e72
gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls ( #107062 )
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-23 22:56:56 +02:00
956b3de816
Remove superflous whitespaces in `layout.html`. (GH-107067)
2023-07-23 17:18:50 +02:00
f5147c0cfb
gh-101100: Fix some broken sphinx references ( #107095 )
2023-07-23 03:23:44 -06:00
f8b7fe2f26
gh-106948: Add standard external names to nitpick_ignore (GH-106949)
...
It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH".
2023-07-22 21:35:22 +03:00
149748ea4f
Fix Sphinx warnings in `re` module docs ( #107044 )
2023-07-22 16:44:44 +01:00
806d7c98a5
gh-101100: Docs: Check Sphinx warnings and fail if improved ( #106460 )
2023-07-22 08:12:43 +00:00
c02ee45031
Docs search: Replace jQuery with vanilla JavaScript ( #106743 )
...
* Replace jQuery with vanilla JavaScript
* Switch 'var' to 'const' or 'let'
2023-07-16 10:26:26 +03:00
e8ab0096a5
Add Plausible for docs metrics ( #106644 )
2023-07-12 05:35:24 +03:00
dac1e36490
Clarify how topics.py gets created. ( #106121 )
...
When changing docs, it was easy to find text in topics.py, and I
wondered whether I was supposed to edit it. Thankfully, the top of the
file says it's auto-generated, so I knew I didn't have to edit it. But I
didn't know what started the auto-generation process.
It's part of the release process, so I'll leave a note here for future
editors.
2023-07-09 20:41:31 -07:00
a72683ba8e
Docs: Avoid a DeprecationWarning in `pyspecific.py` when running with Sphinx >=6.1 ( #105886 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-06-23 08:58:45 +01:00
eaa6702280
Use CSV-separated outputs @ get-changed-files @ CI ( #105151 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-06-21 13:42:59 +03:00
85e5d03163
gh-105096: Reformat wave documentation ( #105136 )
...
Add ".. class::" markups in the wave documentation.
* Reformat also wave.py (minor PEP 8 changes).
* Remove redundant "import struct": it's already imported at top
level.
* Remove wave.rst from .nitignore
2023-05-31 11:29:10 +00:00
a989b73e8e
gh-75552: Remove deprecated tkinter.tix module (GH-104902)
2023-05-27 12:34:19 -05:00
5ab4bc05c4
gh-104804: Remove webbrowser.MacOSX class, deprecated in Python 3.11 ( #104816 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Victor Stinner <vstinner@python.org>
2023-05-26 16:54:15 +03:00
77d7ec5aa9
gh-104773: PEP 594: Remove the chunk module ( #104868 )
...
The module had no tests.
2023-05-25 16:27:55 +00:00
f66be6b11a
gh-104773: PEP 594: Remove the audioop module ( #104937 )
2023-05-25 17:59:00 +02:00
036da3bd43
gh-104773: PEP 594: Remove the aifc module ( #104933 )
...
* Remove .aifc and .aiff test files of Lib/test/audiodata/
* Remove Lib/test/Sine-1000Hz-300ms.aif test file
2023-05-25 17:20:48 +02:00
98c4333e88
gh-104773: Remove the msilib package (GH-104911)
2023-05-24 20:06:00 -05:00
087c1a6539
gh-104773: PEP 594: Remove the xdrlib module ( #104900 )
...
pickle documentation no longer mentions the XDR format.
2023-05-25 00:40:30 +02:00
ded5f1f287
gh-104773: PEP 594: Remove the nntplib module ( #104894 )
...
* socket_helper.transient_internet() no longer imports nntplib to
catch nntplib.NNTPTemporaryError.
* ssltests.py no longer runs test_nntplib.
* "make quicktest" no longer runs test_nntplib.
* WASM: remove nntplib from OMIT_NETWORKING_FILES.
* Remove mentions to nntplib in the email documentation.
2023-05-24 21:15:43 +00:00
c3204ed727
RtD docs previews: Cancel building PRs if no changes in Doc dir ( #104100 )
...
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2023-05-24 16:54:15 +03:00
a5e0f5b230
gh-104773: PEP 594: Remove the sunau module ( #104863 )
...
* Remove Lib/test/audiodata/pluck-*.au files.
* Remove Lib/test/audiotest.au file.
2023-05-24 13:51:59 +00:00
fc07fe4e37
gh-104773: PEP 594: Remove the ossaudiodev module ( #104862 )
...
* Remove ossaudiodev extension in configure.ac and regenerate
the configure script.
* Remove ossaudiodev in Modules/Setup and Modules/Setup.stdlib.in.
2023-05-24 15:00:51 +02:00
ae00b810d1
gh-104780: Remove 2to3 program and lib2to3 module ( #104781 )
...
* Remove the Tools/scripts/2to3 script.
* Remove the Lib/test/test_lib2to3/ directory.
* Doc/tools/extensions/pyspecific.py: remove the "2to3fixer" object
type.
* Makefile and PC/layout/main.py no longer compile lib2to3 grammar
files.
* Update Makefile for 2to3 removal.
2023-05-23 19:40:02 +02:00
9dc476be2d
gh-104773: PEP 594: Remove the telnetlib module ( #104778 )
2023-05-23 07:09:02 +00:00
5612078f68
Python 3.12.0b1
2023-05-22 14:07:36 +02:00
942482c8e6
GH-104284: Fix documentation gettext build ( #104296 )
2023-05-08 19:01:25 +00:00
f5088006ca
GH-97950: Use new-style index directive ('builtin') ( #104164 )
...
* Uncomment builtin removal in pairindextypes
* Use new-style index directive ('builtin') - C API
* Use new-style index directive ('builtin') - Extending
* Use new-style index directive ('builtin') - Library
* Use new-style index directive ('builtin') - Reference
* Use new-style index directive ('builtin') - Tutorial
2023-05-06 06:54:08 +03:00
55d50d147c
GH-97950: Use new-style index directive ('statement') ( #104162 )
2023-05-04 13:48:45 +03:00
3e7995ca11
GH-97950: Use new-style index directive ('exception') ( #104160 )
2023-05-04 13:30:24 +03:00
6ab463684b
GH-97950: Use new-style index directive ('object') ( #104158 )
...
* Uncomment object removal in pairindextypes
* Use new-style index directive ('object') - C API
* Use new-style index directive ('object') - Library
* Use new-style index directive ('object') - Reference
* Use new-style index directive ('object') - Tutorial
2023-05-04 13:04:41 +03:00
b0ce2db118
GH-97950: Use new-style index directive ('operator') ( #104156 )
2023-05-04 12:03:11 +03:00
33ca322c50
GH-97950: Use new-style index directive ('keyword') ( #104153 )
...
* Uncomment keyword removal in pairindextypes
* Use new-style index directive ('keyword') - Reference
2023-05-04 10:44:12 +02:00
d0122372f2
GH-97950: Use new-style index directive ('module') ( #103996 )
...
* Use new-style index directive ('module') - C API
* Use new-style index directive ('module') - Library
* Use new-style index directive ('module') - Reference
* Use new-style index directive ('module') - Tutorial
* Uncomment module removal in pairindextypes
* Use new-style index directive ('module') - C API
* Use new-style index directive ('module') - Library
* Use new-style index directive ('module') - Reference
2023-05-04 10:17:12 +02:00
35d273825a
GH-97950: Allow translation of index directive content ( #104000 )
2023-05-04 10:11:09 +03:00
accb417c33
Replace Netlify with Read the Docs build previews ( #103843 )
...
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-29 23:02:03 -06:00
e1f14643dc
gh-98040: Remove just the `imp` module ( #98573 )
2023-04-28 16:17:58 -07:00
d96cd44a59
gh-103765: Remove pkgutil.rst from .nitignore (GH-103797)
2023-04-24 17:42:43 -06:00
0f23eda4b9
gh-103810: Fix broken references in dataclasses ( #103811 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-04-25 01:26:18 +02:00
79ae019164
gh-101100: Fix Sphinx warnings in `argparse` module ( #103289 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-04-24 15:36:32 -06:00
1e9dfdacef
Docs: use Node.findall to avoid a deprecation warning ( #99403 )
2023-04-08 10:56:20 +03:00
24facd60f6
gh-101100: Use list of 'dirty' docs, with warnings, instead of a clean list ( #103191 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-04-03 21:59:47 +03:00
20c0f196ff
gh-101100: Expand list of clean docs (GH-103135)
...
Follow on from https://github.com/python/cpython/pull/103116 .
Expand list of clean docs files from 3 to 181. These files have no Sphinx warnings, and their presence in this list means that any new warnings introduced will fail the build.
The list was created by subtracting the list of files with warnings from a list of all files.
I tested with all of those, but found that `touch`ing two clean files (https://github.com/python/cpython/blob/main/Doc/includes/wasm-notavail.rst and https://github.com/python/cpython/blob/main/Doc/whatsnew/changelog.rst ) caused a cascade effect and resulted in a number of dirty files being rebuilt too, and failing the build. So those two have been omitted.
Automerge-Triggered-By: GH:hugovk
2023-03-31 03:48:46 -07:00
f192a558f5
gh-101100: Fix Sphinx warning in gc.rst and refactor docs clean list ( #103116 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-30 21:03:50 +03:00
6a1c49a717
gh-101100: Test docs in nit-picky mode ( #102513 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2023-03-24 13:23:35 +02:00
d959bcd4a0
Add gettext support to tools/extensions/c_annotations.py ( #101989 )
2023-03-06 23:20:52 +02:00
6b2d7c0ddb
gh-101101: Unstable C API tier (PEP 689) (GH-101102)
2023-02-28 09:31:01 +01:00
6ef6915d35
gh-101845: pyspecific: Fix i18n for availability directive (GH-101846)
...
pyspecific: Fix i18n for availability directive
If the directive has content, the previous code would nest paragraph
nodes from that content inside a general paragraph node, which confuses
Sphinx and leads it to drop the content when translating. Instead, use a
container node for the body.
Also use set_source_info so that any warnings have location info.
2023-02-12 15:20:11 +01:00
85d5a7e8ef
bpo-37860: re-add netlify.toml to set up deploy previews for docs ( #92852 )
...
* Revert "bpo-46184: remove `netlify.toml` (#30272 )"
This reverts commit fbaf2e604c
2022-12-06 08:37:41 -05:00
d26ee8a0a5
gh-98366: use sphinx.locale._ as gettext() in pyspecific.py ( #98437 )
...
fix(doc-tools): use sphinx.locale._ as gettext() for backward-compatibility in pyspecific.py
[why] spinix 5.3 changed locale.translators from a defaultdict(gettext.NullTranslations) to a dict, which leads to failure of pyspecific.py. Use sphinx.locale._ as gettext to fix the issue.
2022-11-11 02:18:11 +01:00
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
Alex Waygood
Hugo van Kemenade
Samuel Thibault
partev
Nikita Sobolev
Maciej Olko
Tian Gao
T. Wouters
Victor Stinner
Adam Turner
Erlend E. Aasland
Serhiy Storchaka
C.A.M. Gerlach
cocoatomo
Ezio Melotti
wulmer
Ned Batchelder
Sviatoslav Sydorenko
Zachary Ware
Barry Warsaw
Jaime Alonso Lorenzo
Olga Matoula
Rémi Lapeyre
Petr Viktorin
Jean Abou-Samra
Ashwin Ramaswami
Wei-Hsiang (Matt) Wang
Julien Palard
Christian Heimes
luzpaz
Oleg Iarygin
Dong-hee Na
Pablo Galindo
Steve Dower