Minor docs build maintenance #692
Merged
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
* Switch breathe to stable releases. It was previously pulling directly from master because a required bugfix was not in a stable release yet. * Force update sphinx and RTD theme. When using conda, readthedocs pins sphinx==1.3.5 and sphinx_rtd_theme==0.1.7, which is a bit older than the ones used in the RTD regular (non-conda) build. The newer theme has nicer sidebar navigation (4-level depth vs. only 2-level on the older version). Note that the python==3.5 requirement must stay because RTD still installs the older sphinx at one point which isn't available with Python 3.6. [skip ci]
Member
|
Great, thank you! |
Member
|
It looks like the reference was broken by this: |
Member
|
Interestingly, the build on RTD is still marked as "passing". The console lists the following: |
Member
|
Probably some kind of library match ( |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Switch breathe to stable releases. It was previously pulling directly from master because a required bugfix was not in a stable release yet.
Force update sphinx and RTD theme. When using conda, readthedocs pins
sphinx==1.3.5andsphinx_rtd_theme==0.1.7, which is a bit older than the ones used in the RTD regular (non-conda) build. The newer theme has nicer sidebar navigation (4-level depth vs. only 2-level on the older version*). Note that thepython==3.5requirement must stay because RTD still installs the older sphinx at one point which isn't available with Python 3.6. This just updated the theme at a later stage.(*) Compare the sidebar navigation depth on stable (pre-doxygen, non-conda build) vs. master (doxygen, conda build). The latter is currently missing third level navigation (regression after moving to the conda build for doxygen). This PR restores the nicer RTD sidebar.
Note: Skipped CI tests since this is a pure RTD config change, i.e. completely transparent to CI.