juliushaertl/phpdoc-to-rst

This package is abandoned and no longer maintained. No replacement package was suggested.

Generate Sphinx/ReStructured documentation from PHPDoc

Maintainers

Details

github.com/juliushaertl/phpdoc-to-rst

Source

Issues

Installs: 10 880

Dependents: 1

Suggesters: 0

Security: 0

Stars: 3

Watchers: 1

Forks: 7

Open Issues: 8

dev-master 2018-05-28 16:27 UTC

Requires

Requires (Dev)

AGPL-3.0-or-later 9a695417d1f3bb709f60cd5c519e46f1ad08c843

  • Julius Härtl <jus.woop@bitgrid.net>

This package is auto-updated.

Last update: 2020-08-27 16:27:44 UTC

README

Documentation Status Build Status Scrutinizer Code Quality

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/