qt3uw / qt3-utils

Data Acquisition for Confocal Microscope and Spin Control Experiments
https://sites.google.com/uw.edu/qt3-lab/projects
BSD 3-Clause "New" or "Revised" License
3 stars 6 forks source link

Improve documentation #66

Open gadamc opened 1 year ago

gadamc commented 1 year ago

Setup auto documentation creation with sphinx: https://www.sphinx-doc.org/en/master/

gadamc commented 1 year ago

Open to alternative ways to generate documentation, however. Sphinx requires writing in resturcturedTxt format, which is just one more thing to learn. Consider pdoc or pydoc. Ideally, would be able to publish on readthedocs, but that's probably not necessary as long as there's a way to render the output.