Change sphinx theme & pygments_style #1354
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
natalie-perlin
approved these changes
Aug 9, 2022
16 tasks
|
@BrianCurtis-NOAA @DeniseWorthen This is how RTD looks with the change. https://gsp-wm.readthedocs.io/en/docs-themeupdate/Introduction.html. All looks good to me. With approvals, we can merge in. |
BrianCurtis-NOAA
approved these changes
Aug 11, 2022
16 tasks
DeniseWorthen
approved these changes
Aug 11, 2022
…r-model into docs/themeupdate
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.
PR Checklist
This PR is up-to-date with the top of all sub-component repositories except for those sub-components which are the subject of this PR. Please consult the ufs-weather-model wiki if you are unsure how to do this.
This PR has been tested using a branch which is up-to-date with the top of all sub-component repositories except for those sub-components which are the subject of this PR
An Issue describing the work contained in this PR has been created either in the subcomponent(s) or in the ufs-weather-model. The Issue should be created in the repository that is most relevant to the changes in contained in the PR. The Issue and the dependent sub-component PR are specified below.
Results for one or more of the regression tests change and the reasons for the changes are understood and explained below.
New or updated input data is required by this PR. If checked, please work with the code managers to update input data sets on all platforms.
Description
This PR changes the look of the docs to
sphinx_rtd_theme, which has easier sidebar navigation and matches the theme of the SRW and MRW App docs. The new look can be viewed on my ReadTheDocs account here.Issue(s) addressed
This PR partially addresses Issue #1352. I am doing this change separately from the rest of #1352 because occasionally, the theme changes complain on the official repo even when they built perfectly on my own. This has only been an issue for old releases, not on the develop branch, so I don't expect there to be a problem. It is, however, easier to roll back changes to the theme when they are not connected to other updates.
Testing
These changes only affect documentation, not the WM code base. The changes were tested on my own fork/RTD account. They have not been regression tested because the changes do not affect substantive WM code.
Dependencies
N/A
Do PRs in upstream repositories need to be merged first?
No.