ImageGoNord-pip icon indicating copy to clipboard operation
ImageGoNord-pip copied to clipboard

Enable Autodocs

Open Hierosme opened this issue 4 months ago • 2 comments

The documentation hide inside code should be parse by a framework like sphinx or mkdocs, I recommand sphinx for it autodocs plugins.

The docstring format is not a issue but should be verify by a linter like ruff, then consider a ruff approch and reformat

The need to generate the documentation by readthedocs can be done by add a .readthedocs.yml file on the root of the project.

Hierosme avatar Oct 04 '24 10:10 Hierosme