Docs should be generated from code + docstrings.

charmed-kubernetes / pytest-operator

Apache License 2.0

7 stars 13 forks source link

Docs should be generated from code + docstrings. #47

Open johnsca opened 2 years ago

johnsca commented 2 years ago

Currently, docs/reference.md has to be manually maintained and thus has a significant possibility of falling out of sync with the actual set of helpers which are available.

heitorPB commented 2 years ago

I was looking into this project and the documentation is quite hard to read.

Any chance to use Sphinx to generate the docs?