Sphinx - Как сделать autodoc .py файлы, расположенные в нескольких папках?

1

Я новичок как для Python, так и для Sphinx, и пытаюсь создать файлы autodoc python, расположенные в каталоге, подобранном следующим образом:

Project
├── Sphinx
|   ├── index.rst
|   ├── autodoc.rst
|   └──  conf.py
├── Scripts
|   ├── file1.py
|   └──  file2.py
|   ├── folder
|   |   └── file3.py

Мой файл conf.py содержит:

sys.path.insert(0, os.path.abspath("../Scripts/"))

И autodoc содержит:

.. automodule:: file1
  :members:

.. automodule:: file2
  :members:

.. automodule:: folder.file3
  :members:

File3.py не автосогласован правильно (ошибка: нет модуля с именем metric.billpay)

Я также пробовал:

.. automodule:: folder/file3
  :members:

Но я получаю

ПРЕДУПРЕЖДЕНИЕ: недопустимая подпись для автомодуля (u'folder/file3 ')

ПРЕДУПРЕЖДЕНИЕ: не знаете, какой модуль следует импортировать для автоматического документирования u'folder/file3 '(попробуйте поместить в документ директиву "module" или "currentmodule" или указать явное имя модуля)

Кто-нибудь знает, как это исправить? Я новичок в Python, Sphinx и StackOverflow, поэтому извиняюсь, если есть проблемы с этим вопросом.

Теги:
python-sphinx
autodoc

1 ответ

0

Кроме того:

sys.path.insert(0, os.path.abspath("..Scripts/"))

Я добавил это позже:

sys.path.insert(0, os.path.abspath("..Scripts/Folder/"))

Это позволило мне получить доступ к файлам в папке с помощью autodoc.

  • 0
    Ух ты. Последние два дня я бился головой о стену с такой же проблемой, пробуя все, кроме этого. Отлично.

Ещё вопросы

Сообщество Overcoder
Наверх
Меню