Changes learned while working on docs for OneMod #7
Conversation
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
.github/workflows/deploy.yml
Outdated
| run: python -m pip install .[docs] --upgrade pip | ||
| run: | | ||
| python -m pip install .[docs] --upgrade pip | ||
| pip install sphinx sphinx-rtd-theme |
There was a problem hiding this comment.
Thanks @geoffreyphipps-uw! I think we prefer the furo theme rather than the rtd theme. And it is include in the optional dependencies docs, and probably want to stick with that
.github/workflows/deploy.yml
Outdated
| cd docs | ||
| python build.py | ||
| cd .. | ||
| sphinx-build -M html docs docs-out |
There was a problem hiding this comment.
The original build.py contain methods to build documentations for multiple versions. And we probably still want to keep that.
There was a problem hiding this comment.
Within the build.py we can switch to use sphinx-build instead of make from Makefile.
There was a problem hiding this comment.
I don't know why but I couldn't find build.py last week, now I see it. I will switch back to that and retest
There was a problem hiding this comment.
And also update OneMod to match
No description provided.