Сфинкс не может найти мои файлы Python.Говорит "нет модуля с именем ..." - PullRequest
0 голосов
/ 07 декабря 2018

У меня есть вопрос относительно генерации автодока Сфинкса.Я чувствую, что то, что я пытаюсь сделать, должно быть очень простым, но по какой-то причине это не сработает.

У меня есть проект Python, каталог которого называется slotting_tool .Этот каталог находится по адресу C:\Users\Sam\Desktop\picnic-data-shared-tools\standalone\slotting_tool

Я настроил Sphinx с помощью sphinx-quickstart.Тогда моя структура каталогов (упрощенная) выглядит следующим образом:

slotting_tool/
|_ build/
|_ source/
|___ conf.py
|___ index.rst
|_ main/
|___ run_me.py

Теперь я установил корневой каталог моего проекта на slotting_tool, добавив следующее в файл conf.py.

import os
import sys
sys.path.insert(0, os.path.abspath('..'))

Далее я обновляю свой index.rst файл, чтобы он выглядел следующим образом:

.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. automodule:: main.run_me
   :members:

При попытке построить мой HTML с помощью команды sphinx-build -b html source .\build я получаю следующий вывод с no module named ошибка:

(base) C:\Users\Sam\Desktop\picnic-data-shared-tools\standalone\slotting_tool>sphinx-build -b html source .\build
Running Sphinx v1.8.1
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: [] 0 added, 1 changed, 0 removed
reading sources... [100%] index
WARNING: autodoc: failed to import module 'run_me' from module 'main'; the following exception was raised:
No module named 'standalone'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
generating indices... genindex
writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 1 warning.

The HTML pages are in build.

Нет HTML-страниц, которые ссылаются на run_me.py в сборке.Я попытался установить в своем корневом каталоге все различные виды каталогов и попытался заменить все точки . на обратную косую черту \ и т. Д., Но не могу понять, что я делаю неправильно.

Кстати, утверждение о том, что standalone не является модулем, на самом деле верно, это просто каталог без __init__.py.Не знаете, могло ли это вызвать проблемы?

У кого-нибудь есть идеи?

...