A shell scripts/libraries handler for mkdocstrings.
Project description
mkdocstrings-shell
A shell scripts/libraries handler for mkdocstrings. It uses Shellman to collect documentation from shell scripts.
Installation
This project is available to sponsors only, through my Insiders program. See Insiders explanation and installation instructions.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocstrings_shell-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10469fcb2f0ec8f94f15de69c5fe4003e201e227b221409a297f8dc7dbcb6594 |
|
MD5 | 713342bdc1380f063526d9db1c8ae9ac |
|
BLAKE2b-256 | df2f0e2013cdc1898e897b94b6ba08807299af45393d92cba7373ada16bed172 |