mkdocs-click
mkdocs-click copied to clipboard
mkdocs
An MkDocs extension to generate documentation for Click command line applications
Following this [click multi-command example](https://click.palletsprojects.com/en/8.0.x/commands/#custom-multi-commands): Context is being passed around the multi-commands properly when on the command line. So I know my coding is proper. However, `help_option_names`¸for example, isn't being...
Hi there, it would be great if this could also support [asyncclick](https://pypi.org/project/asyncclick/). The changes involved would be fairly minimal, just replacing the click import with: ``` try: import asyncclick as...
Environment variables can be used to set option values:- ```python @click.option( "--debug/--no-debug", default=False, envvar="PRODUCT_DEBUG", help="Output debugging logging", ) ``` However these are not exposed in the CLI documentation. It has...
Hey! Thanks for the develop of `mkdocs-click`, it'll save me a lot of time on documentation 💚 One thing that I would like to suggest is to have a left...
It would be great to allow for the CLI commands generated to be loaded as well into the `objects.inv` that's generated alongside something like `mkdocstrings`. This would let me use...
When creating a context from the command, the context settings were not propagated, which means that some options set on the command would be ignored. To illustrate: ```py import click...
Add a new option `:command_class` that allows a user to specify a custom type for a command class, which will then attempted to be imported. Defaults to `click.BaseCommand`. Closes #80
Unable to use this with https://github.com/python-trio/asyncclick, which should be a pretty much drop in replacement. The error I receive is ``` mkdocs_click._exceptions.MkDocsClickException: 'cli' must be a 'click.BaseCommand' object, got ```...
in my case this adds a number of tables with only the default `--help` option i'd like to exclude it unless its changed
Hi, first of all thanks for your work on this project! I’m opening this issue because I’ve encountered a conflict between `mkdocs-click` and the `show_source` option from the `mkdocstrings` plugin....
