-
-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
BUG: reST section headings do not render #31
Comments
victorlin
added a commit
to nextstrain/augur
that referenced
this issue
Jan 19, 2023
The section headings resulted in warnings: None:8: CRITICAL: Unexpected section title. Comparison methods ================== None:36: CRITICAL: Unexpected section title. Distance maps ============= They rendered fine in the Development API page¹ but did not render on the CLI page². This seems like a bug with sphinx-argparse³. For now, use bold text to avoid the warnings and allow the text to render on the CLI page. ¹ https://docs.nextstrain.org/projects/augur/en/stable/api/developer/augur.distance.html ² https://docs.nextstrain.org/projects/augur/en/stable/usage/cli/distance.html ³ sphinx-doc/sphinx-argparse#31
3 tasks
victorlin
added a commit
to nextstrain/augur
that referenced
this issue
Mar 8, 2023
The section headings resulted in warnings: None:8: CRITICAL: Unexpected section title. Comparison methods ================== None:36: CRITICAL: Unexpected section title. Distance maps ============= They rendered fine in the Development API page¹ but did not render on the CLI page². This seems like a bug with sphinx-argparse³. For now, use bold text to avoid the warnings and allow the text to render on the CLI page. ¹ https://docs.nextstrain.org/projects/augur/en/stable/api/developer/augur.distance.html ² https://docs.nextstrain.org/projects/augur/en/stable/usage/cli/distance.html ³ sphinx-doc/sphinx-argparse#31
victorlin
added a commit
to nextstrain/augur
that referenced
this issue
Mar 9, 2023
The section headings resulted in warnings: None:8: CRITICAL: Unexpected section title. Comparison methods ================== None:36: CRITICAL: Unexpected section title. Distance maps ============= They rendered fine in the Development API page¹ but did not render on the CLI page². This seems like a bug with sphinx-argparse³. For now, use bold text to avoid the warnings and allow the text to render on the CLI page. ¹ https://docs.nextstrain.org/projects/augur/en/stable/api/developer/augur.distance.html ² https://docs.nextstrain.org/projects/augur/en/stable/usage/cli/distance.html ³ sphinx-doc/sphinx-argparse#31
victorlin
added a commit
to nextstrain/augur
that referenced
this issue
Mar 21, 2023
The section headings resulted in warnings: None:8: CRITICAL: Unexpected section title. Comparison methods ================== None:36: CRITICAL: Unexpected section title. Distance maps ============= They rendered fine in the Development API page¹ but did not render on the CLI page². This seems like a bug with sphinx-argparse³. For now, use bold text to avoid the warnings and allow the text to render on the CLI page. ¹ https://docs.nextstrain.org/projects/augur/en/stable/api/developer/augur.distance.html ² https://docs.nextstrain.org/projects/augur/en/stable/usage/cli/distance.html ³ sphinx-doc/sphinx-argparse#31
I don't think this will really be fixable, it's tied in to how the sections get generated, sorry. If someone can PR to fix this we'll review it, but right now this is a "sorry, wontfix" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
The text was updated successfully, but these errors were encountered: