mkdocs / mkdocs-click

An MkDocs extension to generate documentation for Click command line applications

https://pypi.org/project/mkdocs-click

mkdocs/mkdocs-click Issues

Option to append to inventory file with directives for cross-referencing?
Updated a month ago1
Conflicts with front matter
Updated 4 months ago2
Option to remove the top level header for the root command
Updated 4 months ago
Multi-command modules not display correctly
Closed 10 months ago
Documentation only renders when there are at least two spaces at the end of .md file
Closed 10 months ago5
Add to mkdocs wiki plugin overview
Closed 10 months ago1
Can't set up - getting `ModuleNotFoundError`
Closed 10 months ago1
No output generated at all
Closed 10 months ago2
Project Status
Closed 10 months ago7
Indented ::: mkdocs-click blocks are not picked up
Updated 10 months ago
Generate the CLI documentation without first having to install the Python package
Updated 2 years ago
mkdocs serve command fails can't find module specified in :module: attribute
Updated 2 years ago6
Respect clicks docstring `\b` and `\f` markers
Updated 2 years ago
`remove_ascii_art` option doesn't work
Updated 2 years ago1
Escape markdown special characters
Updated 2 years ago
Support for language-agnostic documentation
Updated 2 years ago2
Specify subcommands
Updated 2 years ago2
Add option to exclude `hidden` commands, options and groups
Closed 2 years ago3
Context/Options not being picked up with multi-commands
Updated 2 years ago
Is it possible to disable the repetition of --help option for every command?
Closed 2 years ago1
Support asyncclick?
Updated 3 years ago
Improve visualisation of command hierarchy in headings
Closed 3 years ago
Print options in a sleek table format
Closed 3 years ago6
`--help` should be kept in output instead of hard-dropping it
Closed 3 years ago
Does not generate toc entries (e.g. that are compatible with mkdocs-material)
Closed 4 years ago2
Documenting environment variables used for options
Updated 4 years ago2
Underscore becomes hyphen in usage
Closed 4 years ago1
Python 3.9 support
Closed 4 years ago
Add level highlight left border / custom css
Updated 4 years ago1
Change CLI main command to arbitrary name
Closed 4 years ago2