Update sphinx theme #152
Open
Update sphinx theme #152
+69
−26
Conversation
This file contains hidden or 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
Use the default readthedocs theme instead of our custom theme. This ensure we use the same theme for both 5.x and 6.x documentation. We also benefit from niceties included in the latest readthedocs theme that our custom theme doesn't provide (e.g better mobile layout).
dannycolin
force-pushed
the
update-docs
branch
from
3b7dc55 to
ec02982
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Details
Use the default readthedocs theme instead of our custom theme. This ensure we use the same theme for both 5.x and 6.x documentation. We also benefit from niceties included in the latest readthedocs theme that our custom theme doesn't provide (e.g better mobile layout).
Additional info
bug 2010419
NOTE: Bug number is required. If you haven't filed a bug on https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla yet, don't submit the Pull Request. Please edit the above link to put the bug number both immediately after the # character and after the = character at the end. You can delete this paragraph once you've added your bug number.
Test Plan
You might need to adjust the sphinx version installed in your venv depending on your OS (e.g. Fedora 43 requires Sphinx 7.3+ because it comes with Python 3.14). This shouldn't be an issue in the runner.