Skip to content

Generate Sphinx/ReStructured documentation from PHPDoc

License

Notifications You must be signed in to change notification settings

qury/phpdoc-to-rst

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

70 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

phpdoc-to-rst

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/

About

Generate Sphinx/ReStructured documentation from PHPDoc

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 99.7%
  • Makefile 0.3%