shellman 0.2.1

Write doc in your shell scripts.

Shellman

Write doc in your shell scripts.

Shellman is a Python package that read files, search for special comment lines (documentation) and output formatted documentation as text, markdown or man page.

License

Software licensed under MPL 2.0 license.

Installation

pip install [--user] shellman

Documentation

https://github.com/Pawamoy/shellman/wiki

Development

To run all the tests: tox

Usage

To render the doc on stdout:

shellman FILE
# equivalent to...
shellman --format=text FILE
# other available formats:
shellman --format=man FILE
shellman --format=markdown FILE

You can pass the -o, --output option to specify a file to write to, instead of stdout.

To check if the documentation within a script is correct:

shellman --check --warn FILE         # CI test
shellman --check --failfast FILE     # quick CI test with no output
shellman --check --warn --nice FILE  # always passing test with output

In a script, for automatic help text:

#!/bin/bash

## \brief Just a demo
## \desc This script actually does nothing.

main() {
  case "$1" in
    ## \option -h, --help
    ## Print this help and exit.
    -h|--help) shellman "$0"; exit 0 ;;
  esac
}

## \usage demo [-h]
main "$@"

Output when calling ./demo -h:

Usage: demo [-h]

This script actually does nothing.

Options:
  -h, --help
    Print this help and exit.

Changelog

0.1.0 (2016-11-30)

• Alpha release on PyPI.