uw-ssec / codeuw

Repository of resources and tasks for contributing to scientific software projects
4 stars 4 forks source link

[Code UW]: NoisePy - Generate documentation to readthedocs.io #26

Closed carlosgjs closed 9 months ago

carlosgjs commented 1 year ago

Contact

carlosg@uw.edu

Description

We'd like to have the NoisePy project generate docs automatically using readthedocs.io. The tasks consists on implementing this as part of github workflow.

Tutorial: https://docs.readthedocs.io/en/stable/tutorial/index.html Example configuration from another project: https://github.com/uw-ssec/offshore-geodesy/blob/main/.readthedocs.yml Also see: https://docs.readthedocs.io/en/stable/pull-requests.html#preview-documentation-from-pull-requests

Code Repository

https://github.com/mdenolle/NoisePy

Issue link

https://github.com/mdenolle/NoisePy/issues/190

Task level

L2

What is the primary programming language for the task

python

Additional dependencies

No response