-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs website change: Pydata docs theme #474
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I generally like the idea behind the new workflow, but suggest some improvements to the structure and layout. See detailed comments.
41b59b3
to
6c7b6a0
Compare
Pull Request Test Coverage Report for Build 11766316957Details
💛 - Coveralls |
72148d1
to
5a52595
Compare
@zain-sohail I believe this is also ready now. Please have a final look. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fnished from my side
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have taken a look at the develop docs and looks good. Any doc changes, we can always do later. I'd say we merge and see if the switching is working properly. Otherwise we might need to delete the static files and rebuild them.
fcc636c
to
f68c204
Compare
This PR changes the current readthedocs theme we are using for docs to the pydata docs theme, which supports a lot more features.
Here, we also change the documentation github actions workflow as after building, it will push that versions (like 0.2 etc.) to the docs repo in the sed folder.
The latest main version can be found here: https://opencompes.github.io/docs/sed/latest/
There are some changes to the structure of the documentation (such as seperating user guide, advanced workflows and api) that I saw made more sense but these can be discussed here.
Current main branch is supporting python 3.8 but the pydata theme only supports >3.9 so the workaround is to pip install on the CI for now but in v1, we can change this.