lexixu19 / Duplexity

https://duplexity.readthedocs.io/en/latest/
0 stars 0 forks source link

Add first set of documentation #2

Open emily-bodekerscientific opened 1 month ago

emily-bodekerscientific commented 1 month ago

Firstly, use Sphinx to create readthedocs from docstrings. I believe @lexixu19 is already getting started with this.

emily-bodekerscientific commented 1 month ago

Lexi has started this and we are live on https://duplexity.readthedocs.io/en/latest/ 🥳

Next step is to automate the build of the docs so it stays up-to-date with the codebase. @lexixu19, can you please signup for an account on readthedocs, using your github account, and send me your readthedocs username. I can then add you to the Duplexity project on readthedocs.

We should then look into these pages: https://docs.readthedocs.io/en/stable/guides/automation-rules.html