mkdocstrings-shell 1.0.4

A shell scripts/libraries handler for mkdocstrings.

mkdocstrings-shell

A shell scripts/libraries handler for mkdocstrings. It uses Shellman to collect documentation from shell scripts.

Installation

pip install mkdocstrings-shell

Configuration

In MkDocs configuration file:

plugins:
- mkdocstrings:
    default_handler: shell  # optional

The handler does not offer any option yet.

Usage

Use mkdocstrings syntax to inject documentation for a script:

::: relative/path/to/script
    handler: shell  

Specifying handler: shell is optional if you declared shell as default handler in mkdocs.yml.