Wrap CLI options in description with backticks #544
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is necessary to make Sphinx display them as inline code and so it stops converting double dashes (`--`) to M-dashes (`—`).
webknjaz
requested review from
FFY00,
gaborbernat,
layday and
henryiii
as code owners
|
I've also noticed weird section titles like https://pypa-build.readthedocs.io/en/stable/#python--m-build-options and posted tox-dev/sphinx-argparse-cli#68 upstream assuming it's their bug. cc @gaborbernat |
|
This doesn't seem to render correctly: https://pypa-build--544.org.readthedocs.build/en/544/ |
|
Ah, that's a bummer! I suppose that it's up to @gaborbernat to check this upstream, then? Should we keep the PR open for now? |
|
Sure. |
FFY00
added
documentation
PR to fix that is welcome 😊 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is necessary to make Sphinx display them as inline code and so it stops converting double dashes (
--) to M-dashes (—).