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.
Sponsors
1 maintainer
Metadata
1 maintainer
Release files for mkdocstrings-shell 1.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocstrings_shell-1.0.5.tar.gz | 37.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocstrings_shell-1.0.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 49.7 kB
Release files / mkdocstrings_shell-1.0.5.tar.gz
| Download URL | mkdocstrings_shell-1.0.5.tar.gz |
|---|---|
| Size | 37.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2be49665f19d18f54ad9db5f0acd8fdab5539787b57dd1b6e0fee38d7414d07a
|
|
BLAKE2b-256 checksum How to use checksums |
f398fdaa317683d59a79f5de4b69bd679588bf8c236bf79bdd3b710948f161ff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Release files / mkdocstrings_shell-1.0.5-py3-none-any.whl
| Download URL | mkdocstrings_shell-1.0.5-py3-none-any.whl |
|---|---|
| Size | 12.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b3ae66f6a24cf6f63aea6fcda6a7a59470f5ade7e0f524b13db223ce7be8d399
|
|
BLAKE2b-256 checksum How to use checksums |
697f844965c84067b8b29cb9a56f0243a7da1c95ac8325bff99f14a8d9f152a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
