This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: [doc] incorrect sphinx object names
Type: Stage: patch review
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9, Python 3.8, Python 3.7
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, push-f
Priority: normal Keywords: patch

Created on 2022-02-28 12:47 by push-f, last changed 2022-04-11 14:59 by admin.

Pull Requests
URL Status Linked Edit
PR 31615 open push-f, 2022-02-28 12:48
Messages (1)
msg414192 - (view) Author: Martin Fischer (push-f) * Date: 2022-02-28 12:47
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 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

As can be observed in the URL fragments:

I have a patch, prepared, I'll send a PR straight away.
Date User Action Args
2022-04-11 14:59:56adminsetgithub: 91035
2022-02-28 12:48:48push-fsetkeywords: + patch
stage: patch review
pull_requests: + pull_request29739
2022-02-28 12:47:50push-fcreate