Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specify master_doc to avoid issues with older versions #178

Merged
merged 1 commit into from
Dec 12, 2019

Conversation

maxpkatz
Copy link
Contributor

@maxpkatz maxpkatz commented Dec 8, 2019

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.

Copy link
Contributor

@grahamlopez grahamlopez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tested locally; seems to be fine for our current version.

@grahamlopez grahamlopez merged commit cbe969a into olcf:master Dec 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants