search

Schroedinger-Hat / ImageGoNord-pip

A tool that can convert your rgb images to nordtheme palette
https://ign.schrodinger-hat.it
GNU Affero General Public License v3.0
171 stars 12 forks source link

Enable Autodocs #34

Open Hierosme opened 2 days ago

Hierosme commented 2 days ago

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 commented 2 days ago

Happy if can address it issue

TheJoin95 commented 1 day ago

Happy if can address it issue

It could be nice, thanks!