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
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
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
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
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
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
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
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
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
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
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
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
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
Alex Waygood
Hugo van Kemenade
Nikita Sobolev
Maciej Olko
Victor Stinner
Erlend E. Aasland
Serhiy Storchaka
Adam Turner
wulmer
Zachary Ware
Barry Warsaw
Jaime Alonso Lorenzo
Olga Matoula