Сфинкс генерирует документацию частично - PullRequest
Новая
       61

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

0 голосов
/ 10 июня 2018

В результате выполнения команды 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

1 Ответ

0 голосов
/ 11 июня 2018

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

...