hookedmedia / phpdoc-to-rst
Generate Sphinx/ReStructured documentation from PHPDoc
0.1.0
2018-09-05 17:25 UTC
Requires
- phpdocumentor/reflection: ^4.0.0
- phpdocumentor/reflection-common: 1.0.1
- phpdocumentor/reflection-docblock: 5.0.0-alpha3 as 4.3.0
- symfony/console: ^4.0
Requires (Dev)
- phpunit/phpunit: ^7
This package is not auto-updated.
Last update: 2024-10-25 09:43:53 UTC
README
Generate reStructuredText for Sphinx based documentation from PHPDoc annotations.
This project is heavily based on phpDocumentor/Reflection and makes use of sphinxcontrib-phpdomain.
An example for the documentation output can be found in our own documentation
Quickstart
Install phpdoc-to-rst to your project directory:
composer require --dev juliushaertl/phpdoc-to-rst
Run the command line tool to parse the folders containing your PHP tree and render the reStructuredText files to the output directory:
./vendor/bin/phpdoc-to-rst docs/api/ src/