René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Docstrings in configparser are invalid reStructuredText","articleBody":"In the `configparser` module, the docstrings are not valid rst. I stumbled onto this issue in the [backport](/jaraco/configparser) when I started validating documentation. Here's what the sphinx output looks like when trying to render the docs for that module:\r\n\r\n```\r\ndocs: commands[0] /Users/jaraco/code/jaraco/configparser/docs\u003e python -m sphinx -W --keep-going . /Users/jaraco/code/jaraco/configparser/build/html\r\nRunning Sphinx v5.3.0\r\nloading pickled environment... done\r\nbuilding [mo]: targets for 0 po files that are out of date\r\nbuilding [html]: targets for 0 source files that are out of date\r\nupdating environment: [config changed ('project')] 2 added, 0 changed, 0 removed\r\nreading sources... [100%] index                                                                                                                                    \r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:22: WARNING: Block quote ends without a blank line; unexpected unindent.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:22: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:26: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:30: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:33: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:37: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:44: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:48: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:88: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:88: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:103: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:103: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:103: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:103: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:136: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:9: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:5: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:8: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:8: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:8: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:7: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.\r\nlooking for now-outdated files... none found\r\npickling environment... done\r\nchecking consistency... done\r\npreparing documents... done\r\nwriting output... [100%] index                                                                                                                                     \r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: py:class reference target not found: backports.configparser.Error\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: py:class reference target not found: backports.configparser.Error\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: py:class reference target not found: backports.configparser.Error\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: py:class reference target not found: backports.configparser.Error\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: py:class reference target not found: backports.configparser.Error\r\n/Users/jaraco/code/jaraco/configparser/src/backports/configparser/__init__.py:docstring of backports.configparser:1: WARNING: py:class reference target not found: backports.configparser.Error\r\ngenerating indices... genindex py-modindex done\r\nwriting additional pages... search done\r\ncopying static files... done\r\ncopying extra files... done\r\ndumping search index in English (code: en)... done\r\ndumping object inventory... done\r\nbuild finished with problems, 46 warnings.\r\n```\r\n\r\nIt would be nice if the source documentation would compile nicely under sphinx without warnings.\n\n\u003c!-- gh-linked-prs --\u003e\n### Linked PRs\n* gh-100524\n* gh-100533\n* gh-100534\n\u003c!-- /gh-linked-prs --\u003e\n","author":{"url":"https://github.com/jaraco","@type":"Person","name":"jaraco"},"datePublished":"2022-12-25T08:32:30.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/100520/cpython/issues/100520"}