Comments (2)
Hey @ofek ,
I think the main issue here that there must be a way to document a subcommand with full command path.
In that way the user will have more control over how to divide the documentation into files and stuff.
Since click
doesn't support a way to get the group of a command in its API, one must get the full command path by invoking the group and descend in the group until reaching the subcommand.
from mkdocs-click.
I really support this idea.
I experience the same problem. I have one CLI main group and different sub groups sub_group1, sub_group2 etc. Each sub groups have different commands.
I would like to reference every sub_group in a different page, and maybe even every command in a different page. But I cant because otherwise I won't have the full command path.
This subcommand feature would be very usefull to split its CLI documentation into several pages while keeping the full path. And this should still be possible if we have several group nesting.
Thank you in advance!
from mkdocs-click.
Related Issues (20)
- Add to mkdocs wiki plugin overview HOT 1
- Multi-command modules not display correctly
- mkdocs serve command fails can't find module specified in :module: attribute HOT 6
- Is it possible to disable the repetition of --help option for every command? HOT 1
- Context/Options not being picked up with multi-commands
- Documentation only renders when there are at least two spaces at the end of .md file HOT 5
- Add option to exclude `hidden` commands, options and groups HOT 3
- Support for language-agnostic documentation HOT 2
- `remove_ascii_art` option doesn't work HOT 1
- Escape markdown special characters
- Respect clicks docstring `\b` and `\f` markers
- Generate the CLI documentation without first having to install the Python package
- Can't set up - getting `ModuleNotFoundError` HOT 1
- No output generated at all HOT 2
- Project Status HOT 7
- Indented ::: mkdocs-click blocks are not picked up
- Conflicts with front matter HOT 2
- Option to remove the top level header for the root command
- Option to append to inventory file with directives for cross-referencing? HOT 1
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 mkdocs-click.