DOC: Attempt at fixing theme on RTD #1019
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
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.
Resolves #1018
Now always enforce the use of
sphinx_rtd_theme. Previously, this was not done when the docs were built on RTD, instead using the default theme. I'm not really sure why that was so, maybe the default theme already wassphinx_rtd_themebut was changed later?The docs after this change can be found here:
https://skorch.readthedocs.io/en/docs-try-fixing-rtd-theme/
At first I was suspicious if the change in
conf.pywas really the cause of the fix or if this was not instead somehow related to thelatestversion of the docs. Therefore, I created an empty PR #1020 and checked its docs. Those use the false theme, as can be witnessed here:https://skorch.readthedocs.io/en/docs-experimental-branch-to-check-theme/
Therefore, I think the provided fix should also work for the
latest, and any other, doc version.