Я следую инструкциям по чтению документов, но получаю эту ошибку:
bash Sphinx error: master file /home/docs/checkouts/readthedocs.org/user_builds/mybinders/checkouts/latest/docs/source/contents.rst not found
Вам нужно прочитать файл документации yaml?
Если у вас есть собственный файл conf.py
, он переопределяет файл Read the Doc по умолчанию conf.py
. По умолчанию Sphinx ожидает, что главный документ будет contents
. Вместо этого Read the Docs установит главный документ на index
(или что-то еще, что вы указали в своих настройках). Попробуйте добавить это в свой conf.py
:
master_doc = 'index'
Для получения дополнительной информации ознакомьтесь с этой проблемой: https://github.com/rtfd/readthedocs.org/issues/2569.
Мне нужно было иметь свой conf.py
из-за расширений, которые я использую, поэтому просто добавьте
master_doc = 'contents'
к вашему conf.py
и чем
переименуйте index.rst
в contents.rst
.
После того, как сборка пройдет успешно, вы по-прежнему ничего не увидите в ReadTheDocs, кроме «Эта страница все еще не существует», просто перейдите по ссылке:
https://your-project.readthedocs.io/en/latest/contents.html
И вы увидите там свои документы.