mkdocs-click
mkdocs-click copied to clipboard
mkdocs
An MkDocs extension to generate documentation for Click command line applications
The following does not appear to have any effect on the title: ```markdown --- title: CLI reference --- ::: mkdocs-click :module: hatch.cli :command: hatch :depth: 0 :style: table :remove_ascii_art: true...
I would like to set the depth to `1` and prevent the generated h1 so I can set my own to `CLI reference`. Alternatively, an option to explicitly set the...
Users of mkdocstrings noticed that indented mkdocs-click blocks are not picked up and handled by mkdocs-click, and later (block processors) mkdocstrings picks it up (we use the same syntax `:::`)...
Hi, Is there any way to generate documentation for the CLI without first having to install the Python package and dependencies? One of the dependencies takes a while to build...
# Description I am getting a `ModuleNotFoundError` exception thrown when trying to start the `mkdocs serve` development server and even trying to do `mkdocs build`. I'm not sure why it...
`\b`: > https://click.palletsprojects.com/en/8.1.x/documentation/#preventing-rewrapping Rewrapping can be disabled on a per-paragraph basis by adding a line with solely the \b escape marker in it. `\f`: >https://click.palletsprojects.com/en/8.1.x/documentation/#truncating-help-texts You can use the \f...
https://github.com/DataDog/mkdocs-click/blob/a8742d9afc6bfd0ce70e048383a623fc218625f8/README.md?plain=1#L137 [docs/index.md](https://github.com/DeadNews/encode-utils-cli/blob/cc7311211ef658fe80cd6ec979e1aa18b927d335/docs/index.md?plain=1#L6): ``` :remove_ascii_art: True ``` [Docstring](https://github.com/DeadNews/encode-utils-cli/blob/cc7311211ef658fe80cd6ec979e1aa18b927d335/src/encode_utils_cli/re_titles.py#L19): ```py """ Replace titles names from anidb. The result will be copied to the clipboard. \b >>> 1 The Prince`s New Clothes
[Docstring](https://github.com/DeadNews/encode-utils-cli/blob/cc7311211ef658fe80cd6ec979e1aa18b927d335/src/encode_utils_cli/re_titles.py#L19): ```py """ Replace titles names from anidb. The result will be copied to the clipboard. \b >>> 1 The Prince`s New Clothes
I'm writing docs with i18n support. There are two places where it should be done: 1. All docstrings of click-command functions and options help arguments. Like this: ```python @click.option('--quiet/--verbose', '-q/-v',...
# Description When documenting CLI, one can choose to document all the commands in a single file, or to split the documentation to multiple files by subgroups. Right now, if...
