@8bitjoey

Как сделать автосборку документации из PHP проекта для Sphinx?

Есть Sphinx, который умеет собирать документацию из rst (файлы в формате ReST) файлов в нужные форматы.
Есть проект на CodeIgniter для которого нужно сделать документацию, при этом phpdoc в файлах имеется (описание классов, методов и т.д.).

Если я правильно понимаю, надо ручками писать и поддерживать rst файлы.
Может еще использовать вывод других утилит (например, Doxygen) в формате sphinx.

Но неужели нет никакой команды, чтобы я сделал:
$ generate-rst-by-php-code -o docs .
и она бы сделала все нужное? А потом еще в makefile ее запихать.

Причем, чую, что если я буду в php файлах писать документацию сразу в формате ReST, то какая-то утилита найдется. Но не уверен, захотят ли другие члены команды писать в этом формате. Да и сам я что-то не рвусь. (Пример от CodeIgniter: https://www.codeigniter.com/userguide3/documentati....)
  • Вопрос задан
  • 172 просмотра
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы