RTD компилирует все мои документы, включая сторонние, из подмодулей git

Я экспериментирую с Sphinx и ReadTheDocs (RTD) для компиляции моей документации при каждом нажатии на GitHub. К сожалению, RTD обнаружил несколько _1 _ / _ 2_ папок, содержащих conf.py файл.

Мой репозиторий использует подмодули git для встраивания сторонних библиотек. Некоторые из них также задокументированы с помощью Sphinx. Я предполагаю, что самая большая (долговечная сборка документации) побеждает и перезаписывает все статические HTML-страницы в окончательном виде RTD.

Как я могу исключить или указать RTD игнорировать папки этих подмодулей:

lib/cocotb
lib/osvvm
lib/vunit
docs/source/_themes/sphinx_rtd_theme

Моя документация находится здесь:

docs/source/conf.py
docs/source/index.rst

Насколько я обнаружил, RTD поддерживает *.yml файлы, но нет записи для определения корневой папки документации.

Есть идеи по решению моей проблемы?


git-submodules python-sphinx read-the-docs
person Paebbels    schedule 16.05.2016    source источник

Ответы (2)


arrow_upward
0
arrow_downward

Внутри conf.py есть список, который выглядит так

 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = []

Вы можете поместить в него файлы, которые хотите игнорировать, например

exclude_patterns = ["lib/cocotb", "lib/osvvm", "lib/vunit", "docs/_themes/sphinx_rtd_theme"]

Обратите внимание, что здесь шаблон относится к исходному каталогу, вы можете поставить / в начале каждого шаблона файла выше, чтобы сделать это более понятным.

person xxks-kkk    schedule 18.05.2016
comment
Когда я компилирую документы локально, эти папки не включаются. Исключение *.rst или других исходных файлов из поиска не мешает RTD находить несколько conf.py файлов по всему репозиторию. Файл conf.py находится в папке docs/source. Итак, эти каталоги lib выходят за рамки. - person Paebbels; 18.05.2016
comment
Вы можете попытаться указать весь относительный путь conf.py в exclude_patterns, чтобы увидеть, будут ли эти файлы по-прежнему включены при сборке - person xxks-kkk; 19.05.2016

arrow_upward
0
arrow_downward

Основную папку документации и ее conf.py можно настроить на вкладке Дополнительные параметры в настройках для каждого проекта.

Пример значения: documentation/conf.py

person Paebbels    schedule 24.05.2016