Closed ortengren closed 5 months ago
@rosecers @ortengren
Should we have the documentation update every time we push to main through a github action? Something like https://stackoverflow.com/questions/57989790/using-github-actions-to-publish-documentation?rq=2
Yes
On Jun 3, 2024, at 11:36 AM, arthur-lin1027 @.***> wrote:
@rosecers https://github.com/rosecers @ortengren https://github.com/ortengren Should we have the documentation update every time we push to main through a github action? Something like https://stackoverflow.com/questions/57989790/using-github-actions-to-publish-documentation?rq=2
— Reply to this email directly, view it on GitHub https://github.com/cersonsky-lab/AniSOAP/pull/34#issuecomment-2145661018, or unsubscribe https://github.com/notifications/unsubscribe-auth/ALKVP3XZYQSRRIOJLYSSFOTZFSLR7AVCNFSM6AAAAABEELWIC6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNBVGY3DCMBRHA. You are receiving this because you were mentioned.
I can look into RTD webhooks and try to get that working.
I think it looks great. @rosecers should we leave the github action for automatically updating the readthedocs for a later PR?
That should be fine, although it may be possible to setup outside of a PR
It should be done through the readthedocs itself
Formatted all docstrings to align with NumPy standard. Added configuration settings for Sphinx and ReadTheDocs, and built HTML files for API documentation.