mkdocstrings-shell

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

Installation

pip install mkdocstrings-shell

In MkDocs configuration file:

plugins:
- mkdocstrings:
    default_handler: shell  # optional

The handler does not offer any option yet.

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.

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for mkdocstrings-shell 1.0.4
File	Size	Uploaded
mkdocstrings_shell-1.0.4.tar.gz	46.3 kB	Mar 28, 2025	Details

Table of built distributions (wheels) for mkdocstrings-shell 1.0.4
File	Interpreter	ABI	Platform	Reset
mkdocstrings_shell-1.0.4-py3-none-any.whl 12.5 kB Mar 28, 2025	Python 3	none	any	Details

Total release size: 58.8 kB

Download URL	mkdocstrings_shell-1.0.4.tar.gz
Size	46.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`bc2405f2c120b56a3210fa46ef2a0b839a41dbff98417a70186dbf1e136f2391`
BLAKE2b-256 checksum How to use checksums	`f6137c5b273a234399cf601536b914ec7fd8fa154981221dca948e891de3e160`
Upload date	Mar 28, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.2`

Download URL	mkdocstrings_shell-1.0.4-py3-none-any.whl
Size	12.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`0a6cfe69d763ee828ee53dab30f6243b8b18b785a084bb4e90b19cae53446108`
BLAKE2b-256 checksum How to use checksums	`dd9e8422b510459a170784aa6400148b5bf5a6c70322b10593080bb9804f63e9`
Upload date	Mar 28, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.2`