UMEP-dev / SuPy

SUEWS that speaks Python
https://supy.readthedocs.io/
GNU General Public License v3.0
13 stars 7 forks source link

questions regarding documentation under OSSS project #84

Closed sunt05 closed 1 year ago

sunt05 commented 1 year ago

SuPy will be merged into SUEWS soon, so future discussions will be based on the merged version.


sunt05 commented 1 year ago
  • [x] best practice to integrate inline comments (e.g. docstrings) into documentation

https://sphinx-automodapi.readthedocs.io/en/latest/

theme: https://pydata-sphinx-theme.readthedocs.io/en/latest/

sunt05 commented 1 year ago
  • [x] best practice in maintaining documentation

https://numpydoc.readthedocs.io/en/latest/validation.html