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.

Author jugmac00
Recipients docs@python, jugmac00
Date 2021-05-05.06:48:11
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1620197291.49.0.201849852188.issue44044@roundup.psfhosted.org>
In-reply-to
Content
I wanted to copy a hyperlink to the documentation section for ConfigParser's optionxform method, but in https://docs.python.org/3/library/configparser.html you cannot link to this one section, as the paragraph was marked with `:noindex:` via https://github.com/python/cpython/pull/21859 / bpo-40204

The `:noindex:` workaround was introduced to silence doc build errors which came with a new Sphinx version.

Without the workaround, you get errors like...

P.S.: I uploaded a screenshot of the documentation section showing the heading before optionxform has a permalink, optionsxform does not.


Warning, treated as error:
/home/jugmac00/Projects/cpython/Doc/library/configparser.rst:1170:duplicate object description of configparser.ConfigParser.optionxform, other instance in library/configparser, use :noindex: for one of them
Makefile:49: recipe for target 'build' failed
make: *** [build] Error 2

Looks like a possible fix to this problem would involve a major restructuring of the configparser documentation, to avoid the "duplicated object description".

Maybe there is a simpler solution?
History
Date User Action Args
2021-05-05 06:48:11jugmac00setrecipients: + jugmac00, docs@python
2021-05-05 06:48:11jugmac00setmessageid: <1620197291.49.0.201849852188.issue44044@roundup.psfhosted.org>
2021-05-05 06:48:11jugmac00linkissue44044 messages
2021-05-05 06:48:11jugmac00create