Read the docs theme update#1117
Open
hkershaw-brown wants to merge 3 commits into
Open
Conversation
turning off this html output. Maybe we want an index? Currently the .. index entries are used to 'hack' the js search. This does not work with the read-the-docs server side search
Member
Author
|
Also if you are building the docs locally note new requirements.txt for the new theme. |
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
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.
Description:
This pull request updates the documentation them to sphinx-rtd-theme==3.1.0
The reason for updating is to use the readthedocs search.
Note for reviewers, the readthedocs search is only on the web (docs.dart.ucar.edu/version). Local builds will still have the same search as we have now.
The small downside I have found is that readthedocs doesn't instantly update the search index it builds, but I don't think this is a dealbreaker.
The setting
html_use_index = False
is to stop building an index page (D for data assimilation, O for awesome, etc.). We'd been using this to force results to show up in the previous theme's search. We may actually want an index page at some point in the future.
Fixes issue
fixes #1106
Types of changes
Documentation changes needed?
Tests
Please describe any tests you ran to verify your changes.
Local builds, and
https://docs.dart.ucar.edu/en/rtd-theme-update/index.html
Checklist for merging
Checklist for release
Testing Datasets