search

ccpem / roodmus

GNU General Public License v3.0
3 stars 0 forks source link

Setup sphinx docs #35

Open JatGreer opened 4 months ago

JatGreer commented 4 months ago

Possible setup could be similar to: https://github.com/alan-turing-institute/empiarreader/issues/50

JatGreer commented 4 months ago

I'm halfway through creatings a sphinx docs, will try to make sure it stable tomorrow

JatGreer commented 3 months ago

docs, added - merged to development in v0.0.28. Example here: https://roodmus.readthedocs.io/en/jgreer-docs/ Suggest to follow this style guide for writing docs: https://diataxis.fr/

Need to update to components of the docs and make sure docstrings/code is automatically picked up to make API docs, then merge that version into main/v0.3.0