Python Sphinx — Можно ли создать дерево оглавления из моего домена PHP?
Поэтому я пишу документацию по PHP для моей библиотеки.
Я использую расширение «sphinxcontrib.phpdomain» для поддержки домена PHP.
Допустим, я определил следующий документ:
.. toctree::
:numbered:
:maxdepth: 3
:caption: Couch
.. php:class:: Couch
This is the low-level class that handles communications with CouchDB.
.. php:method:: dsn()
:returns: The dsn of the current Couch instance
Можно ли из этого создать дерево оглавления? Например, я хотел бы проиндексировать в дереве имена классов и членов классов.
На данный момент в toctree индексируются только пользовательские заголовки.
Решение
Разделите ваш пример reStructuredText на два файла. toctree Директива должна быть в index.rst файл вашей документации, а также php:class Директива должна быть в отдельном файле. Было бы целесообразно назвать такой файл в соответствии с именем класса, например, couch.rst, Это, по крайней мере, даст вам оглавление высшего уровня.
Не знаю sphinxcontrib.phpdomain поддерживает записи TOC, отличные от простых имен файлов и заголовков reStructuredText внутри файлов. Если предположить, sphinxcontrib.phpdomain не предоставляет желаемую глубину оглавления, вы можете попробовать вставить произвольные заголовки.
В Python у нас есть autodoc который автоматически документирует код Python, но я понятия не имею, работает ли он с кодом PHP. В противном случае может быть какой-то пакет для PHP, как autodoc для Python.
Другие решения
Других решений пока нет …