sphinx back up one directory

Question

Я следил за этим guide, чтобы настроить Sphinx.

Мои каталоги являются:

/cms-service 
    /documentation 
    /modules 
    models.rst 

Руководство говорит, чтобы поместить путь к питона файлов в models.rst. Каким должен быть этот путь? Очевидно, .. automodule:: cms-service.apps.models не работает, я продолжаю получать две ошибки при запуске make html. Думаю, мне нужно идти по одному каталогу, но я не знаю, как это сделать.

Ошибки:

КМВ-сервис/документация/модули/models.rst: 3: ВНИМАНИЕ: недействительная подпись для automodule (u'cms-service.apps.models')

cms-service/documentation/modules/models.rst: 3: ПРЕДУПРЕЖДЕНИЕ: не знаю, какой модуль необходимо импортировать для автодокументации u'cms-service.apps.models '(попробуйте поместить «модуль» или «текущий модуль», в документе или с указанием явного имени модуля)

Любые другие руководства по настройке Sphinx также приветствуются. Я пытался в течение нескольких дней ...

Answer 1

Cyber, Я искал один и тот же блог, чтобы продолжить процесс autodoc с Sphinx и Django. Я думаю, что в учебнике есть ошибка.

В файле module/models.rst в учебнике используется project.app.models, таким образом Sphinx не может найти модуль для обработки. Однако, если вы измените его на app.models, он может найти ваш модуль.

Я не думаю, что нам нужно добавить название проекта, поскольку оно уже указано в conf.py.