Сфинкс не распознает подкаталоги - PullRequest
Новая
       0

Сфинкс не распознает подкаталоги

0 голосов
/ 07 декабря 2018

Я пытаюсь написать простую документацию для небольшого примера.Вот мой макет каталога: 

..
├── docs
│   ├── build
│   │   └── modules.rst
│   ├── Makefile
│   └── source
│       ├── conf.py
│       └── index.rst
└── src
    ├── __index__.py
    └── utilities
        ├── __index__.py
        └── my_file.py

Я пытаюсь сгенерировать файлы HTML для my_file.py

index.rst: 

.. toctree::
   :maxdepth: 9
   :caption: Contents:
   :glob:
   utilities/*
   utilities

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

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

Запуск sphinx-apidoc -o build ../src толькогенерировать modules.rst, а не my_file.rst.Если я переместу my_file.rst в папку src, то она будет работать нормально, однако я хочу иметь возможность документировать файлы в папках.

Насколько я понимаю, добавление utilities в index.rst должно включать каталог, который нужно документировать.

Есть ли способ заставить sphinx рекурсивно находить каталоги?У меня большая кодовая база с сотнями папок, которые необходимо документировать, и я бы не стал добавлять каждый подкаталог в index.rst

...