Я начал документировать проект Python с помощью Sphinx. Я использую его впервые - я привык к инструментам, которые работают с синтаксисом, подобным JavaDoc, и у меня есть некоторые сомнения.
Поскольку я хочу, чтобы документация располагалась рядом с кодом, я использую .. automodule ::
, .. autoclass ::
и .. automethod ::
директивы. Итак, структура моей документации выглядит следующим образом: index.rst
содержит TOC и
.. automodule:: my_main_package
, а затем верхний уровень __ init __. Py
содержит директивы типа
.. automodule:: some_subpackage
для каждого подпакета и так далее. Наконец, каждый модуль содержит директивы
.. autoclass:: some_class
:members:
для каждого класса в модуле.
В основном это работает, но я получаю одностраничную документацию, с которой немного странно работать.
Как мне организовать свою документацию, чтобы получить дерево файлов с гиперссылками? То есть основной пакет должен содержать свою собственную документацию и ссылки на каждый из его подпакетов и так далее, пока каждый модуль не будет иметь свою собственную страницу.