Catalog PyPI
PACKAGE EXPLORERView in registry

aidee-living-docs

PyPI

Helpers for generating living documentation with Sphinx and Behave

Versions collected1
Direct dependencies2From release 1.0.7
Last observed21 Oct, 10:26 UTC

README

Version 1.0.7 documentation

Aidee Living Documentation Helpers

PyPI Status Python Version License

Tests

pre-commit Black

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

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 1

Collected releases
VersionPublishedDirect dependenciesOpen version
1.0.718 Dec 20252

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Repository

PENDING
aidee-health/aidee-living-docs

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 21 Oct, 10:26 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:5b3c857dcda6118da5b3d2040c2ed13cc6aba2d0968e2cbde99b50d42f43894e