Use Canonical-ish theme from canonical/sphinx-docs-starter-pack #941
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
Also rename "Operator Framework" to "Charmed Operator Framework" for clarity and consistency with our SDK docs.
|
Only thought I had was how we keep the theme styles in sync over time (they could change?) |
|
@jnsgruk Yeah, my thought exactly. It's going to be a bit manual for now, but per https://library.canonical.com/documentation/read-the-docs-at-canonical, the web and design team are working on a proper Canonical theme for Sphinx. So I think it's okay if this needs to be updated/merged manually till then. At that point we can just reference the canonical Canonical theme. |
|
Per discussion on Mattermost, this isn't perfect but it's more improvement than not, and it's more Canonical-looking. Going to merge this now. |
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.
It's not perfect, but I think it's probably an improvement to be more consistent with Canonical styling. We'll update to the Canonical "Vanilla" theme once the web & design team are ready with that.
I definitely don't love the
_compute_navigation_treepatch we have to do inconf.py(it seems like there's an oversight in the Furo theme to not fall back to the "local TOC" like the sphinx-rtd-theme did). But it will do the job for now, and hopefully the Canonical theme will address it properly.You can view the rendered version here: https://ops--941.org.readthedocs.build/en/941/