Generate the documentation for the package

BienfaitKI / polus-dev

MIT License

5 stars 25 forks source link

Generate the documentation for the package #7

Open SamJHirst opened 1 month ago

SamJHirst commented 1 month ago

The documentation will ideally generate an HTML output.

Suggested tools include:

pydoc
autosummary/sphinx
doxygen

VladBagat commented 1 month ago

At least pydoc uses existing docstrings to generate documentation. I’m not sure that current version of program has any docstrings, so we will need to do that first…