Sphinx частично генерирует документацию

В результате команды make html Sphinx генерирует документацию только для некоторых модулей. Другие модули остаются недокументированными.

Структура проекта:

|- my-project
|--| my_project
|--| docs
|----| _build
|------| ...
|----| _static
|------| ...
|----| _templates
|------| ...
|---- conf.py
|---- index.rst
|---- Makefile
|---- source
|-----| modules.rst
|-----| ...

conf.py:

import os
import sys
sys.path.insert(0, os.path.abspath('../'))
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.autosummary',
    'sphinx.ext.viewcode',
    'sphinx.ext.napoleon',
]
autosummary_generate=True
source_suffix = '.rst'

index.rst:

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

   ./source/modules


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

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

source/modules.rst:

my_project
==========

.. toctree::
   :maxdepth: 4

   my_project

Пожалуйста, обратите внимание на исходники на github: https://github.com/mxmaslin/Test-tasks/tree/removeme/tests_python/my-project


person mr_bulrathi    schedule 10.06.2018    source источник
comment
Как установить свой проект? Там нет файла требований setup.py или pip. Если ваш проект не установлен, я думаю, именно поэтому вы получаете все ошибки импорта.   -  person Steve Piercy    schedule 11.06.2018
comment
В prediction/models/__init__.py одним из операторов импорта является from baseline.median import MedianForecaster. Разве это не должно быть from my_project.prediction.models.baseline.median import MedianForecaster?. Или, может быть, просто from .baseline.median import MedianForecaster (точка добавлена ​​для относительного импорта)?   -  person mzjn    schedule 11.06.2018
comment
Я поместил setup.py в репозиторий. Пожалуйста, подумайте о том, чтобы посмотреть   -  person mr_bulrathi    schedule 11.06.2018
comment
Можно ли создать МИНИМАЛЬНЫЙ тестовый пример (минимальный воспроизводимый пример)? Проект GitHub довольно большой и запутанный (по крайней мере, для меня...).   -  person mzjn    schedule 11.06.2018
comment
Спасибо, @mzjn! Ваш комментарий относительно импорта решил мою проблему! Ты замечательный!   -  person mr_bulrathi    schedule 11.06.2018


Ответы (1)


Проблема была в неправильном импорте. Спасибо @mzjn за указание на это

person mr_bulrathi    schedule 11.06.2018