Specify master_doc to avoid issues with older versions #178
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.
On a system I was using where I was using sphinx and sphinx-rtd-theme from Ubuntu rather than from pip, my version of sphinx-build was old enough (1.6.7) that the RTD theme didn't work without specifying
master_doc
. I found the solution on SO:https://stackoverflow.com/questions/56336234/build-fail-sphinx-error-contents-rst-not-found
which is consistent with the Sphinx documentation:
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-master_doc
I tested this on both my older install that required it, and a newer one that didn't, and it works for both cases.