groensch24/phpdoc-to-rst

Generate Sphinx/ReStructured documentation from PHPDoc

dev-master 2022-10-07 15:40 UTC

Requires

• phpdocumentor/reflection: ^5.2
• symfony/console: ^5.1

Requires (Dev)

• phpunit/phpunit: ^9.5

AGPL-3.0-or-later

• Julius Härtl

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/