New submission from Jürgen Gmach <juergen.gm...@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 <rep...@bugs.python.org>
<https://bugs.python.org/issue44044>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to