Helpers for generating living documentation with Sphinx and Behave
Project description
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
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aidee_living_docs-1.0.3.tar.gz.
File metadata
- Download URL: aidee_living_docs-1.0.3.tar.gz
- Upload date:
- Size: 10.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ccca91014438baec5ec068af9c2f2457f2abae7fe369e4a13c485dd0226b117e
|
|
| MD5 |
199ca4d84562a8fd32b3931c9493b283
|
|
| BLAKE2b-256 |
dcd0c0503c39a4035e5480318fa131a7dce63a5631349bb170dddba25140ed61
|
File details
Details for the file aidee_living_docs-1.0.3-py3-none-any.whl.
File metadata
- Download URL: aidee_living_docs-1.0.3-py3-none-any.whl
- Upload date:
- Size: 12.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e52b34c2cc6ce82cfc2adcc6c7d79d54ee8dddeff99edc27c7d804b435fe1e3a
|
|
| MD5 |
5c3cd1f6c777a3e9e9e6911a53dd6cce
|
|
| BLAKE2b-256 |
50f70df1fe1dd2d2c6427a6f62fab3da1b1cd6a21132c7fbff91e50d7a9732ea
|
