6a8944acb6
gh-101100: Fix sphinx warnings in `library/email.mime.rst` (GH-114635)
2024-01-27 10:45:40 +02:00
01d970c1b8
gh-101100: Fix sphinx warnings in `c-api/file.rst` ( #114546 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-26 02:55:22 -07:00
51d9068ede
gh-101100: Fix Sphinx warnings in `c-api/structures.rst` ( #113564 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2024-01-24 15:40:09 +02:00
8744ecf589
gh-101100: Fix sphinx warnings in `concurrent.futures.rst` ( #114521 )
2024-01-24 15:30:50 +02:00
1e4f00ebd8
gh-101100: Fix sphinx warnings in `asyncio-task.rst` ( #114469 )
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-01-24 00:23:34 -07:00
5277d4c7db
Docs: mark up FTP.retrbinary and FTP.storbinary with param lists ( #114399 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2024-01-23 14:53:35 +01:00
7d21cae964
gh-101100: Fix sphinx warnings in `Doc/library/locale.rst` ( #114425 )
...
* gh-101100: Fix sphinx warnings in `Doc/library/locale.rst`
* Remove `/` from signatures
2024-01-23 13:05:27 +02:00
8ccd1ba461
gh-101100: Fix Sphinx warnings in `reference/expressions.rst` ( #114194 )
2024-01-22 18:21:14 +02:00
47133d8d86
gh-101100: Fix sphinx warnings in `Doc/c-api/memory.rst` ( #114373 )
2024-01-21 11:34:43 +02:00
1d6989f9b0
Fix typo in c_annotations.py comment ( #108773 )
...
"compatability" => "compatibility"
2024-01-16 23:36:01 +01:00
af85274086
Docs: Align multiprocessing.shared_memory docs with Sphinx recommendations ( #114103 )
...
- add :class: and :mod: markups where needed
- fix incorrect escaping of a star in ShareableList arg spec
- mark up parameters with stars: *val*
- mark up list of built-in types using list markup
- remove unneeded parentheses from :meth: markups
2024-01-16 12:35:35 +00:00
c2808431b3
gh-101100: Fix Sphinx warnings in `howto/urllib2.rst` and `library/http.client.rst` ( #114060 )
2024-01-14 20:38:53 +00:00
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
eb53750757
gh-101100: Fix Sphinx warnings in `library/pyclbr.rst` ( #113739 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-01-05 19:15:07 +00:00
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
30a6d79fb8
gh-101100: Fix Sphinx warnings in `library/configparser.rst` ( #113598 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-31 10:57:33 -07:00
8e5d70f4b6
gh-101100: Fix Sphinx warnings in library/random.rst ( #112981 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-28 12:29:12 -07:00
4acf825058
gh-101100: Fix Sphinx warnings in `library/cmd.rst` ( #113502 )
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-27 12:17:30 +02:00
fb02b66960
gh-101100: Fix Sphinx warnings in `library/calendar.rst` ( #113500 )
2023-12-27 09:36:17 +00:00
2b53c767de
gh-101100: Fix Sphinx warnings in `library/bisect.rst` ( #113496 )
2023-12-26 14:12:15 -07:00
4e67644d36
gh-101100: Fix Sphinx warnings in `howto/isolating-extensions.rst` ( #113493 )
2023-12-26 12:40:48 -07:00
f428c4dafb
gh-101100: Fix Sphinx warnings in library/tarfile.rst ( #113237 )
...
Fix Sphinx warnings in library/tarfile.rst
2023-12-18 08:57:45 +02:00
c2c4879b0a
gh-101100: Fix Sphinx nitpicks in `library/numbers.rst` ( #113162 )
2023-12-15 19:05:12 +02:00
7bb00f053e
gh-101100: Fix Sphinx nitpicks in `library/rlcompleter.rst` ( #113125 )
2023-12-15 10:57:23 +02:00
25061f5c98
gh-101100: Cleanup `mailbox` docs ( #113124 )
2023-12-14 14:10:26 -07:00
961f1043a0
gh-101100: Fix Sphinx warnings in `whatsnew/2.3.rst` ( #112373 )
2023-12-14 13:48:36 -07:00
006355b2a9
gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst` ( #113116 )
2023-12-14 19:25:55 +00:00
d9e1b5794a
gh-101100: Fix Sphinx nitpicks in `library/traceback.rst` ( #113106 )
2023-12-14 14:10:35 +00:00
4b3cb082da
gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and `reference/simple_stmts.rst` ( #113107 )
2023-12-14 13:30:57 +00:00
0d2fe6bab0
gh-87286: Add a number of LOG_* constants to syslog ( #24432 )
...
* bpo-43120: Add a number of LOG_* constants to syslog
This adds a number of syslog facilities to the syslogmodule.c.
These values are available on macOS.
* Switch contant documentation to the data directive
This fixes a CI warning and matches the pattern
used in the documentation for ``os``.
* Update Doc/library/syslog.rst
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-12 10:25:51 +01:00
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
7595d47722
gh-101100: Fix Sphinx warning in library/http.cookies.rst ( #112908 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-10 05:53:26 -07:00
54410e6bd9
gh-101100: Fix Sphinx nitpicks in `library/tempfile.rst` ( #112886 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-09 22:08:01 +00:00
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
Nikita Sobolev
Hugo van Kemenade
Erlend E. Aasland
Kuan-Wei Chiu
William Andrea
Ege Akman
Hugo van Kemenade
Alex Waygood
Ronald Oussoren
Adam Turner
Samuel Thibault
partev
Maciej Olko
Tian Gao
T. Wouters
Victor Stinner
Serhiy Storchaka
C.A.M. Gerlach
cocoatomo