Aidee Living Documentation Helpers

Features

• Helper functions to generate living documentation with Sphinx and Behave
• Type safe code using mypy for type checking

Requirements

• Python 3.9-3.11

Installation

You can install Aidee Living Documentation via pip:

$ pip install aidee-living-docs

This adds aidee-living-docs as a library, but also provides the CLI application with the same name.

Using the application from the command line

The application also provides a CLI application that is automatically added to the path when installing via pip.

Once installed with pip, type:

aidee-living-docs --help

To see which options are available.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project has been heavily inspired by Bluefruit