Как пропустить Python исходные файлы в readthedocs Sphinx build - PullRequest
Новая
       38

Как пропустить Python исходные файлы в readthedocs Sphinx build

1 голос
/ 06 марта 2020

Как я могу сказать readthedocs не загружать файлы Python, расположенные в верхней папке root?

Справочная информация: я бы хотел, чтобы readthedocs создал документацию Sphinx для дополнения Blender Python, размещено на github. Я создал папку docs в хранилище для файлов Sphinx. Я могу собрать документы Sphinx OK на моем локальном компьютере (в каталоге документов), но сборка readthedocs завершается ошибкой 

  File "/home/docs/checkouts/readthedocs.org/user_builds/bvtknodes/envs/latest/lib/python3.7/site-packages/pip/_internal/utils/misc.py", line 20, in <module>
    from pip._vendor import pkg_resources
  File "/home/docs/checkouts/readthedocs.org/user_builds/bvtknodes/envs/latest/lib/python3.7/site-packages/pip/_vendor/pkg_resources/__init__.py", line 41, in <module>
    import inspect
  File "/home/docs/checkouts/readthedocs.org/user_builds/bvtknodes/checkouts/latest/inspect.py", line 1, in <module>
    import bpy
ModuleNotFoundError: No module named 'bpy'

Причиной этой ошибки было то, что inspect.py модуль находился в root каталог, поэтому процесс установки readthedocs загружен, а не системная версия проверяемого модуля. Когда я переименовал свой inspect.py в b_inspect.py, тогда процесс создания документов завершился правильно в readthedocs. Однако это всего лишь обходной путь, есть ли лучшее решение?

Первоначальная неправильная интерпретация: Кажется, что readthedocs пытается проверить __init__.py (находится на верхнем уровне папки и не может переместиться оттуда в подпапку) содержимое и сборка завершится неудачно, когда не может import bpy. AFAIK нет способа установить модуль bpy через pip (но я бы не хотел этого делать в любом случае). Я бы хотел, чтобы readthedocs игнорировал все файлы python. language = None и extensions список в docs/conf.py пуст. Я также установил параметр «Python файл конфигурации» в расширенных настройках readthedocs на docs/conf.py. Спасибо!

Вот ссылка на сборку readthedocs, которая не удалась .

...