Comments (2)
Many thanks for the thorough answer @stephenfin. Didn’t know it was a limitation from Sphinx. It’s a bit sad that I can’t have both help prompts be the same, but I guess it’s not a big problem :)
from sphinx-click.
We can't do this, at least not entirely. We're relying on directives from the Sphinx standard domain under the hood. These have certain requirements around formatting. Relevant to this issue, the option
directive insists that "[o]ption argument names should be enclosed in angle brackets." (reference). We need to generate our own defaults, as you can see here. Now we could change the default metavar used for special cases such as the type=click.Path
example you gave, but I don't think that extra logic is necessarily worth it: things will already look different.
For references, looking at the example in the docs, on the command line I see:
❯ python examples/commands/cli.py --help
Usage: cli.py [OPTIONS] ARG
A sample command.
Options:
--param TEXT A sample option
--another [FOO] Another option
--choice [Option1|Option2] A sample option with choices
--numeric-choice <choice> A sample option with numeric choices
--flag A boolean flag
--config FILE
--help Show this message and exit.
While in the docs I see:
--param <param>
A sample option
--another <FOO>
Another option
--choice <choice>
A sample option with choices
Options:
Option1 | Option2
--numeric-choice <choice>
A sample option with numeric choices
Options:
1 | 2 | 3
--flag
A boolean flag
--config <config>
from sphinx-click.
Related Issues (20)
- add build-backend to pyproject.toml
- 4.0.0: sphinx warnings `reference target not found` HOT 7
- Missing detection of envvars via auto_envvar_prefix-option HOT 1
- Extend \b rewrapping to click options HOT 2
- Nested subcommands improvement HOT 1
- Supports `.. click:example::` and `.. click:run::` directives HOT 3
- Option defaults with escape characters don't render correctly HOT 5
- <class ‘click.core.Command’>” of type “scripts.my module:mycommand” is not click.Command or click.Group.”click.BaseCommand” HOT 1
- Missing show_default detection via context_settings. HOT 1
- _format_envvars does not seem to support auto_envvar_prefix on group HOT 1
- remove "Required argument" from every click arg HOT 1
- Sphinx_click not working with Read The Docs HOT 2
- Issue with sphinx 7.0 HOT 2
- "\b" prevents formatting HOT 1
- Support myst-parser HOT 3
- Document sub-command only
- Consider adding the sphinx-extension GitHub topic HOT 1
- Tests fail with click 8.1.x HOT 1
- :nested: full doesn't work anymore HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sphinx-click.