8
8
8bitjoey2015-10-26 18:37:29
PHP
8bitjoey, 2015-10-26 18:37:29

How to autobuild documentation from a PHP project for Sphinx?

There is Sphinx , which can collect documentation from rst (files in ReST format ) files into the required formats.
There is a project on CodeIgniter for which you need to make documentation, while there is phpdoc in the files (a description of classes, methods, etc.).
If I understand correctly, it is necessary to write and maintain rst files with pens.
It can also use the output of other utilities (for example, Doxygen) in sphinx format.
But is there really no command for me to do:
$ generate-rst-by-php-code -o docs .
and it would do everything right? And then push it into the makefile.
Moreover, I feel that if I write documentation in php files immediately in the ReST format, then some utility will be found. But I'm not sure if other team members would like to write in this format. Yes, and I myself am not torn. (Example from CodeIgniter: https://www.codeigniter.com/userguide3/documentati... .)

Answer the question

In order to leave comments, you need to log in

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question