mkdocs / mkdocs-click

An MkDocs extension to generate documentation for Click command line applications
https://pypi.org/project/mkdocs-click
Apache License 2.0
105 stars 15 forks source link

Allow using full command paths in headers #36

Closed florimondmanca closed 3 years ago

florimondmanca commented 3 years ago

Closes #35

Description

Allows progressively enhancing rendering to output full command paths, instead of only command names.

The only change is that headers show eg ddev env ls instead of ls, and permalinks are eg #ddev-env-ls instead of #ls.

We need the attr_list extension to be installed, so to bring this change progressively we check for the extension instead of making it a hard-requirement, and keep the old behavior as a fallback (AKA progressive enhancement). This does take a bit of additional code.

For cases when attr_list is already present, I think this behavior is better in any case, so no need for a "force-disable" flag.

Preview

before after