Aidee Living Documentation Helpers
Features
- Helper functions to generate living documentation with Sphinx and Behave
- Type safe code using ty 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
1 maintainer
Metadata
1 maintainer
Release files for aidee-living-docs 1.0.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| aidee_living_docs-1.0.7.tar.gz | 8.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aidee_living_docs-1.0.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 21.5 kB
Release files / aidee_living_docs-1.0.7.tar.gz
| Download URL | aidee_living_docs-1.0.7.tar.gz |
|---|---|
| Size | 8.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dda1cc4b2b0534798e50c502b1d7005f71034cc460d3236f0be5eec8f9cc90cb
|
|
BLAKE2b-256 checksum How to use checksums |
e55446f72ce396d266d65b0b7b68764c1d644d964c5856131f34368a40c1c9ae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / aidee_living_docs-1.0.7-py3-none-any.whl
| Download URL | aidee_living_docs-1.0.7-py3-none-any.whl |
|---|---|
| Size | 12.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
10c6a1c962d25bc0b48d0ef8220428fa8ecd33f2fb59ffa6aeaf84f9f2888f5e
|
|
BLAKE2b-256 checksum How to use checksums |
ed2a6fd18b6eba8956844345136f355ec4ed28fe7f97510262c37c4442cf900a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Security for aidee-living-docs 1.0.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
