reStructuredText headings do not render, and result in a CRITICAL build warning when run in nitpicky (-n) mode.
Steps to reproduce
Create a file sample.py:
import argparse
def main():
parser = argparse.ArgumentParser(
description="""
This is a section title
-----------------------
`I'm a link <http://www.google.com>`__
"""
)
parser.add_argument('cmd', help='execute a `command`')
return parser
Description
reStructuredText headings do not render, and result in a
CRITICAL
build warning when run in nitpicky (-n
) mode.Steps to reproduce
Create a file
sample.py
:Create a file
index.rst
:Create a file
conf.py
:Build it with nitpicky mode (
sphinx-build . _build -n
).Note this warning in the output:
Built HTML shows the link but not the section title: