search

mkdocs / mkdocs-click

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

Option to append to inventory file with directives for cross-referencing? #78

Open kratsg opened 2 weeks ago

kratsg commented 2 weeks ago

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 the native cross-referencing of something like [my-entrypoint subprogram][] to generate a cross-reference, rather than [my-entrypoint subprogram](references#my-entrypoint-subprogram) at the moment.

pawamoy commented 2 weeks ago

In the meantime you could also try to enable autorefs' full-mode by listing it in plugins, in mkdocs.yml. Then just use your command anchors as identifiers: [my-entrypoint subprogram][my-entrypoint-subprogram] probably.