New submission from Jürgen Gmach juergen.gmach@googlemail.com:
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?
---------- assignee: docs@python components: Documentation files: Screenshot from 2021-05-05 08-46-05.png messages: 392977 nosy: docs@python, jugmac00 priority: normal severity: normal status: open title: ConfigParser: cannot link to ConfigParser.optionxform(option) Added file: https://bugs.python.org/file50014/Screenshot from 2021-05-05 08-46-05.png
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue44044 _______________________________________
Shreyan Avigyan shreyan.avigyan@gmail.com added the comment:
No there's a hyperlink. See here https://docs.python.org/3/library/configparser.html#configparser.ConfigParse.... There's two duplicate definitions of ConfigParser.optionxform in configparser.html. One gives examples, the other one gives definition.
---------- nosy: +shreyanavigyan
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue44044 _______________________________________
Jürgen Gmach juergen.gmach@googlemail.com added the comment:
Shreyan Avigyan, thanks for your feedback, but you are linking to the wrong section.
And yes I know, there are two sections describing `optionxform`, which is the root cause for this problem in the first place.
Anyway, I wanted to reference the section which I marked in the screenshot, and it is not possible to do so, because of the `:noxindex:` directive.
----------
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue44044 _______________________________________
Shreyan Avigyan shreyan.avigyan@gmail.com added the comment:
If that's the problem then what about merging the two sections together?
----------
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue44044 _______________________________________
Jürgen Gmach juergen.gmach@googlemail.com added the comment:
If that's the problem then what about merging the two sections together?
That would be one solution, which I suggested in my initial comment:
Looks like a possible fix to this problem would involve a major restructuring of the configparser documentation, to avoid the "duplicated object description".
----------
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue44044 _______________________________________
-
Jürgen Gmach -
Shreyan Avigyan