Skip to content
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.

Sign up for GitHub

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

Jump to bottom

CLI help text can't contain rST section headings #1657

Open
Tracked by #1642
victorlin opened this issue Oct 23, 2024 · 0 comments
Open
Tracked by #1642

CLI help text can't contain rST section headings #1657

victorlin opened this issue Oct 23, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@victorlin
Copy link
Member

Upstream issue

Context

rST section headings can't be used in argparse descriptions, prompting workarounds such as 844c10c. More discussion in #1095 (comment).

Possible solutions

  1. Continue replacing section headings with bold text as a workaround (status quo).
  2. Replace sphinxarg.ext with sphinx.ext.autodoc. The latter is used in Nextstrain CLI and has no issues with section headings.
@victorlin victorlin added the documentation Improvements or additions to documentation label Oct 23, 2024
This was referenced Oct 23, 2024
Open
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@victorlin