Автомодуль Sphinx: не удалось импортировать модуль - PullRequest
Новая
       28

Автомодуль Sphinx: не удалось импортировать модуль

0 голосов
/ 19 июня 2019

Я учусь Сфинкс документировать мой Django проект.

Моя структура проекта похожа на 

app
|- docs
   |- build
   |- source
      |- conf.py
      |- index.rst
   |- make.bat
   |- Makefile
|- src
   |- authentication
      |- __init__.py
      |- models.py
      |- ...
   |- myapp
      |- __init__.py
      |- settings.py
      |- wsgi.py
   |- manage.py

в `app / docs / source / conf.py путь для поиска документа установлен как 

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

и index.rst имеет содержимое 

App's documentation!
=============================================

.. automodule:: manage
   :members:

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



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

при работе 

make html

Создает пустую страницу документации с содержимым по умолчанию и без содержимого из приложения Django.

У меня создано много приложений, и каждое приложение содержит много файлов. Я хочу автоматически генерировать документацию из строки документации в приложении Django.

1 Ответ

0 голосов
/ 19 июня 2019

Посмотрите на это https://medium.com/@sschannak/sphinx-for-django-documentation-2b9c900c6cfa. Похоже, вам не хватает настройки django, и вам нужно добавить .. automodule:: для ваших модулей проекта, которые вы хотите документировать.

...