juliushaertl / phpdoc-to-rst
Generate Sphinx/ReStructured documentation from PHPDoc
Installs: 10 873
Dependents: 1
Suggesters: 0
Security: 0
Stars: 3
Watchers: 1
Forks: 7
Open Issues: 8
Requires
- phpdocumentor/reflection: dev-develop
- phpdocumentor/reflection-common: 1.0.1
- symfony/console: ^4.0
Requires (Dev)
- phpunit/phpunit: ^4.8|^7.0
This package is auto-updated.
Last update: 2020-08-27 16:27:44 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/