Dirk's Tech Findings

Read the Docs: Build fails with "contents.rst not found"

Publication date: 2020-08-17

Issue: Build on "Read the Docs" fails with "contents.rst not found"

When building documentation on "Read the Docs" (see https://readthedocs.org), the build fails with the error "contents.rst not found".

Solution: Specify "master_doc" in config file

Explicitly specify "master_doc = 'index'" in "conf.py" for documentation named "index.rst" to avoid "Read the Docs" defaulting to "contents.rst".

Hint towards the solution

https://github.com/readthedocs/readthedocs.org/issues/2569

https://stackoverflow.com/questions/56336234/build-fail-sphinx-error-contents-rst-not-found

Back to topic list...