Может ли сфинкс ссылаться на документы, расположенные на один путь выше документа .rst?

Я пытаюсь использовать основы Sphinx для документирования небольшого проекта. Но я не могу заставить его найти файлы, которые находятся в каталоге выше.

Структура проекта следующая:

/ Пользователи / машина / рабочая область / проект1

├── BDRespostas.py
├── constantes.py
├── docs
│   ├── conf.py
│   ├── index.rst
│   └── make.bat
├── estatisticas.py
├── migrate_postgre_sqlite.py
├── preProcessamentoTextual.py
└──

И я попытался настроить index.rst несколькими способами, но безуспешно:

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

   :ref:'estatisticas.py'
   ../BDRespostas.py
   '/Users/machine/workspace/project1/constantes.py'

Я также объединил несколько попыток с добавлением sys.path.insert () в каталог проекта. Если вам уже удалось сделать эту ссылку и вы можете мне помочь, я очень ценю это.


python python-sphinx toctree
person erfelipe    schedule 16.08.2020    source источник
comment
toctree записи - это имена файлов RST. Вы не можете использовать toctree для ссылки на модули Python. См. stackoverflow.com/q/45195363/407651.   -  person mzjn    schedule 16.08.2020
comment
Спасибо за внимание @mzjn, я прочитал ваш ответ. Я понял, что тогда нельзя поставить .py таким образом. Я просмотрел документацию и не могу найти, как это сделать, поместил файлы .py, которые хочу задокументировать. Я продолжу поиски.   -  person erfelipe    schedule 16.08.2020
comment
@erfelipe, вы используете макет проекта без каталога src, вот один пример. Думайте о файлах .rst как о чем-то промежуточном: .py - ›.rst -› .html. Вы создаете .rst файлы, используя sphinx-apidoc (посмотрите пример), или можете создать .rst файлы вручную. Это файлы .rst, которые будут использоваться Sphinx для извлечения строк документации из модулей .py.   -  person bad_coder    schedule 16.08.2020
comment
Если вы просто хотите включить файлы, расположенные за пределами вашего каталога docs, вы можете использовать обычную директиву include [1] реструктурированного текста, которая поддерживает относительные пути. [1]: documenttils.sourceforge. io / docs / ref / rst /   -  person whme    schedule 21.08.2020

Ответы (1)


arrow_upward
0
arrow_downward

Как сказано выше, toctree предназначен для включения документов (файлов .rst), а не источников Python. Расскажите нам, чего вы хотите достичь.

Чтобы не замалчивать это - toctree может включать документы только из текущей папки или дочерних папок. Т.е. ты не можешь

.. toctree::
   
   ../one.rst
   ../two/three.rst
person Matt    schedule 21.08.2020