diff options
author | Martin Fischer <martin@push-f.com> | 2022-05-19 15:34:58 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-05-19 15:34:58 (GMT) |
commit | 2cdd57f119e3b85f1bfd28c7ff040e0d9bcaf115 (patch) | |
tree | 4499a0514a488347f6b98b517f6ae9ae808d1c6d /Doc/library/multiprocessing.rst | |
parent | 84b86000e2bc32b0fbb6dfb6445a7ffc882067d2 (diff) | |
download | cpython-2cdd57f119e3b85f1bfd28c7ff040e0d9bcaf115.zip cpython-2cdd57f119e3b85f1bfd28c7ff040e0d9bcaf115.tar.gz cpython-2cdd57f119e3b85f1bfd28c7ff040e0d9bcaf115.tar.bz2 |
bpo-46879: Fix incorrect sphinx object names in doc (GH-31615)
API members documented in sphinx have an object name, which allow the
documentation to be linked from other projects. Sphinx calculates the
object name by prefixing the current module name to the directive
argument, e.g:
.. module:: foo
.. function:: bar.baz
becomes foo.bar.baz. Since these anchors aren't displayed in the
documentation, some mistakes have crept in, namely the Python stdlib
documentation currently contains the objects:
* asyncio.asyncio.subprocess.DEVNULL
* asyncio.asyncio.subprocess.PIPE
* asyncio.asyncio.subprocess.STDOUT
* asyncio.asyncio.subprocess.Process
* multiprocessing.sharedctypes.multiprocessing.Manager
* xml.etree.ElementTree.xml.etree.ElementInclude
This commit fixes this by making use of the :module: option which
without an argument makes sphinx take the directive argument as is
for the object name (avoiding the prefixing of the current module
name that led to these broken object names).
Co-authored-by: Ćukasz Langa <lukasz@langa.pl>
Diffstat (limited to 'Doc/library/multiprocessing.rst')
-rw-r--r-- | Doc/library/multiprocessing.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index 70802ee..2a66b0f 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -1666,6 +1666,7 @@ different machines. A manager object controls a server process which manages proxies. .. function:: multiprocessing.Manager() + :module: Returns a started :class:`~multiprocessing.managers.SyncManager` object which can be used for sharing objects between processes. The returned manager |