build icon indicating copy to clipboard operation
build copied to clipboard

Wrap CLI options in description with backticks

Open webknjaz opened this issue 3 years ago • 5 comments

This is necessary to make Sphinx display them as inline code and so it stops converting double dashes (--) to M-dashes ().

webknjaz avatar Dec 01 '22 15:12 webknjaz

I've also noticed weird section titles like https://pypa-build.readthedocs.io/en/stable/#python--m-build-options and posted https://github.com/tox-dev/sphinx-argparse-cli/issues/68 upstream assuming it's their bug.

cc @gaborbernat

webknjaz avatar Dec 01 '22 15:12 webknjaz

This doesn't seem to render correctly: https://pypa-build--544.org.readthedocs.build/en/544/

layday avatar Dec 01 '22 16:12 layday

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?

webknjaz avatar Dec 01 '22 20:12 webknjaz

Sure.

layday avatar Dec 01 '22 21:12 layday

Ah, that's a bummer! I suppose that it's up to @gaborbernat to check this upstream, then?

PR to fix that is welcome 😊

gaborbernat avatar Feb 01 '24 15:02 gaborbernat

Seem stalled.

gaborbernat avatar Jan 24 '25 16:01 gaborbernat