Skip to content
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

Merged
merged 18 commits into from
Nov 10, 2024
Merged

Conversation

zain-sohail
Copy link
Member

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.

Copy link
Member

@rettigl rettigl left a 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.

.cspell/custom-dictionary.txt Outdated Show resolved Hide resolved
.github/workflows/documentation.yml Show resolved Hide resolved
.github/workflows/documentation.yml Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
docs/user_guide/config.md Outdated Show resolved Hide resolved
docs/user_guide/index.md Outdated Show resolved Hide resolved
docs/user_guide/index.md Outdated Show resolved Hide resolved
docs/user_guide/installation.md Show resolved Hide resolved
docs/workflows/index.md Outdated Show resolved Hide resolved
@rettigl rettigl mentioned this pull request Oct 13, 2024
12 tasks
@rettigl rettigl force-pushed the pydata-docs-theme-main branch from 41b59b3 to 6c7b6a0 Compare October 22, 2024 18:50
@coveralls
Copy link
Collaborator

coveralls commented Oct 22, 2024

Pull Request Test Coverage Report for Build 11766316957

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 91.948%

Totals Coverage Status
Change from base Build 11662147388: 0.0%
Covered Lines: 6486
Relevant Lines: 7054

💛 - Coveralls

@rettigl rettigl force-pushed the pydata-docs-theme-main branch 12 times, most recently from 72148d1 to 5a52595 Compare October 25, 2024 13:18
@rettigl
Copy link
Member

rettigl commented Oct 25, 2024

@zain-sohail I believe this is also ready now. Please have a final look.

@rettigl rettigl mentioned this pull request Oct 25, 2024
Copy link
Member

@rettigl rettigl left a 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

Copy link
Member Author

@zain-sohail zain-sohail left a 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.

@zain-sohail zain-sohail force-pushed the pydata-docs-theme-main branch from fcc636c to f68c204 Compare November 10, 2024 15:20
@zain-sohail zain-sohail merged commit 25e7bac into main Nov 10, 2024
6 checks passed
@zain-sohail zain-sohail deleted the pydata-docs-theme-main branch November 10, 2024 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants