ImageGoNord-pip
ImageGoNord-pip copied to clipboard
Enable Autodocs
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.