Swap mkdocs theme for Material #43
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The sidebar for the Python docs contains many items. It does not scroll properly, as noted in mkdocs/mkdocs#2780. Swapping to use the Material theme is an easy change and looks better, in my opinion. The Material theme does not have the same scrolling issue.
robbieaverill
force-pushed
the
python-docs-review
branch
from
fadc7ff to
cfaea8b
Compare
Tim-Evans-Seequent
approved these changes
Apr 2, 2025
…e info As part of this we overload a couple of templates in order to customise them. We remove a trailing colon (sounds like localisation is not fully implemented, so changing a dictionary is not an option), and remove the default place where attributes are listed as we now display them in the summary.
Tim-Evans-Seequent
approved these changes
Apr 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes:
The sidebar for the Python docs contains many items. It does not scroll properly, as noted in mkdocs/mkdocs#2780.
Swapping to use the Material theme is an easy change and looks better, in my opinion. The Material theme does not have the same scrolling issue.
In the Python docs, we use the "summary" view for attributes, which includes auto linking to more info for the types. This works for local types, e.g.
Oreint3orImageArray, as well as native Python types.Unfortunately, Rust methods annotations on the class's attributes are not being picked up by the parser, so we don't have descriptions on class attributes yet. With the summary view in place, you can now click on the type of the attribute to get more information, including a description.