uafgeotools / waveform_collection

Collect seismic/infrasound waveforms and metadata from IRIS/WATC/AVO servers, local miniSEED files, etc.
https://uaf-waveform-collection.readthedocs.io/
MIT License
13 stars 7 forks source link

Use Sphinx and Read the Docs for automatic documentation generation and hosting #14

Closed liamtoney closed 4 years ago

liamtoney commented 4 years ago

This PR implements a modern documentation solution with Sphinx for generation and Read the Docs for hosting, similar to what was done for the RTM code in this PR. The documentation is hosted at uaf-waveform-collection.readthedocs.io.

The functions in cd11.py, clf.py, css.py, and smart24.py are currently not included in the documentation, since I didn't get around to editing their docstrings. They can be included in the future — once their docstrings are edited — by removing the variable apidoc_excluded_paths from doc/conf.py.

Post-merge TO-DO: