-
-
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
Refactor the extension to use a Sphinx Domain #34
base: main
Are you sure you want to change the base?
Conversation
mikemckiernan
commented
Feb 8, 2023
•
edited by AA-Turner
Loading
edited by AA-Turner
- Add optional command index and optional commands-by-group index.
- Optionally, print fully-qualified subcommand name in title.
- Support commands:command role for intersphinx.
- Prefer fully-qualified HREF targets:
- Use targets like "#blah-sub-commands" as the primary target and move historic targets like "#Sub-commands" to secondary targets.
- Preserve the older HREF, "#sub-commands", as a secondary target. In the HTML, this becomes a span just below the section element so that bookmarks continue to work even after adopting the update from this commit.
767a66b
to
b1c1fc8
Compare
The majority of the doc updates are visible at https://sphinx-argparse--34.org.readthedocs.build/en/34/usage.html#printing-fully-qualified-sub-command-headings. PLMK if you spot some uglies. |
@ashb , just checking if if there's anything I can answer or do to ease the review. PLMK and thanks. |
Bumping this. |
- Print fully-qualified subcommand name in title - Support commands:command role for intersphinx - Prefer fully-qualified HREF targets Use targets like "#blah-sub-commands" as the primary target and move historic targets like "#Sub-commands" to secondary targets. Preserve the older HREF, `sub-commands`, as a secondary target. In the HTML, this becomes a span just below the section element so that bookmarks continue to work even after adopting the update from this commit.
Remaining is to resolve |
Thanks very, very much @AA-Turner for dusting off this PR and improving it. For your comment about confvals rather than the dictionary, is the idea that the
I don't have any strong feelings and I trust your judgement. PLMK what you have in mind and I'll see what I can do. Thanks again! |