Прочитайте Документы: Как указать, где находятся ваши источники - PullRequest
Новая
       75

Прочитайте Документы: Как указать, где находятся ваши источники

0 голосов
/ 30 марта 2020

Я работаю над пакетом python со структурой папок 

- my_package
    - setup.py
    - docs
         -source
               - conf.py
               - index.rst
    - my_package
        (python modules)

index.rst выглядит так: 

My package
==========

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


Indices and tables
------------------

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


Description
------------

Blablabla

conf.py был сгенерирован sphinx и использует все значения по умолчанию, кроме как в начале: 

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

Следуя инструкциям, я закончил компиляцию документации моего машинного сфинкса со следующей командной строкой: 

sphinx-apidoc -f -o source/ ../my_package/ && make html

Это прекрасно работает и генерирует полная HTML документация, с подходящими индексами и индексом модуля.

Как только мои репозитории github сошлись для чтения документов, сборка прошла успешно, документация генерируется. Индекс выглядит нормально, содержимое index.rst отображается правильно. Но индекс пуст, а индекс модуля не существует («извините, эта страница еще не существует»). Инструмент поиска find только с является частью index.rst и ничего больше. Похоже, источник и связанные с ним строки документов так и не были найдены.

Я посмотрел на результаты сборки, но ничего не бросилось в глаза.

...