Ошибка импорта ReadTheDocs из __init__.py - PullRequest
Новая
       19

Ошибка импорта ReadTheDocs из __init__.py

0 голосов
/ 27 апреля 2018

У меня проблемы с автодокументами readthedocs - сборка завершена, но моя документация пуста для каждого класса.

При просмотре информации о сборке, похоже, появляется синтаксическая ошибка, которая вызывает несколько предупреждений: 

print(clean_sample, file=open(new_fname, 'w'))

Однако, это совсем не похоже на ошибку.

Вот информация о сборке https://readthedocs.org/projects/medembed/builds/7108142/

Моя файловая структура: 

MedEmbed/
  docs/
    build/
    source/
      code.rst
      conf.py
      index.rst
  medembed/
    __init.py
    main.py
    transformer.py
    dataset.py
    embedding.py

Как таковой, я добавил в conf.py:

sys.path.insert(0, os.path.abspath('../../medembed'))

Я мог бы очень признателен за совет, пожалуйста

РЕДАКТИРОВАТЬ: Python3 Sphinx решил выше.

Теперь я импортирую константу DIR_PROCESSED из init.py

Почему-то Сфинксу это не нравится: 

from medembed import DIR_PROCESSED
ImportError: No module named 'medembed

Сборка не удалась: https://readthedocs.org/projects/medembed/builds/7108602/

1 Ответ

0 голосов
/ 27 апреля 2018

Было несколько вещей, которые не работали правильно со Сфинксом.

  • code.rst: вы должны указать имя пакета для каждого модуля, который вы хотите запустить autodoc на: 

    .. automodule:: medembed.main
   :members:

.. automodule:: medembed.dataset
   :members:

.. automodule:: medembed.embedding
   :members:

.. automodule:: medembed.transformer
   :members:

  • conf.py: путь, который вы хотите добавить к SYSPATH - это путь к родительскому каталогу пакета, а не сам пакет: 

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

  • main.py, dataset.py, embedding.py, transformer.py: вы должны использовать относительный импорт вместо абсолютного, когда импортируете вещи из вашего пакета: 

    -from transformer import Transformer
+from .transformer import Transformer

-from medembed import DIR_PROCESSED
+from . import DIR_PROCESSED

-from dataset import TxtDataset, XMLDataset
-from embedding import Embedding
+from .dataset import TxtDataset, XMLDataset
+from .embedding import Embedding

  • main.py: не добавлять директиву if __name__ == "__main__": код будет выполняться при анализе Sphinx, и это не то, что вам нужно (см. в этом посте ). На самом деле, sphinx запрещает это и возвращает предупреждение, если вы попытаетесь: 

    WARNING: autodoc: failed to import module 'medembed.main'; the module executes module level statement and it might call sys.exit().

    Вместо этого вы должны создать main.py в родительском каталоге, который не будет анализироваться с помощью sphinx: 

    from medembed.main import main

if __name__ == '__main__':
    main()

    Я использую абсолютный импорт здесь, поскольку этот main.py файл отсутствует в пакете medembed.

Я создал пул-запрос для вашего репо со всеми этими изменениями: https://github.com/isaacsultan/MedEmbed/pull/4

...