Skip to content

Conversation

@Alex-Welsh
Copy link
Member

No description provided.

@Alex-Welsh Alex-Welsh requested a review from a team as a code owner November 13, 2025 13:02
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation theme to sphinx-immaterial, which is a nice visual upgrade. The changes are mostly configuration for the new theme. I have two suggestions for improvement: first, to pin the new sphinx-immaterial dependency in requirements.txt for more stable and reproducible builds. Second, I've suggested a change to the theme's color palette toggle configuration in conf.py to make it more intuitive for users switching between light and dark modes.

sphinx>=4.2.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
Sphinx-Substitution-Extensions # Apache-2.0
sphinx-immaterial # MIT

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To ensure reproducible documentation builds and prevent unexpected breakages from future updates, it's a good practice to pin the version of this dependency. You could specify a minimum version or an exact version. For example, sphinx-immaterial>=0.11.1.

sphinx-immaterial>=0.11.1 # MIT

@Alex-Welsh
Copy link
Member Author

Not worth the time to fix issues right now

@Alex-Welsh Alex-Welsh closed this Nov 13, 2025
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