-
Notifications
You must be signed in to change notification settings - Fork 10
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
Update documentation to use sphinx-immaterial theme #1311
Conversation
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferencesCodacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more |
To view the documentation locally, download the artifact created in the "Documentation" workflow (see workflow for a link), extract the archive, and serve it e.g. with |
8e9dc26
to
9d8cbfb
Compare
9d8cbfb
to
18d8f87
Compare
Given that it's easy to use the unreleased version of sphinx-immaterial, and the official documentation only needs to build successfully in exactly one environment, I think it's relatively safe to rely on the unreleased version. I've pushed some final cleanups to this branch so it's ready to be reviewed. |
The current theme, sphinx-material, isn't very actively developed: bashtage/sphinx-material#141. The author even suggests using sphinx-immaterial: https://github.com/jbms/sphinx-immaterial. This PR updates the documentation to use sphinx-immaterial, but relies on jbms/sphinx-immaterial#338 at the moment for some newer features.
A few improvements:
I've also changed all the logos in the Acknowledgements to pngs, optimized them, and added a white background to the ETHZ logo (it was previously an svg with transparent background, leading to black text on black background in dark mode).