PHP Classes

File: docs/cli.rst

Recommend this page to a friend!
  Classes of Francesco Danti   Sphinx PHP Doc RST   docs/cli.rst   Download  
File: docs/cli.rst
Role: Auxiliary data
Content type: text/plain
Description: Auxiliary data
Class: Sphinx PHP Doc RST
Generate Sphinx documentation from PHPDoc comments
Author: By
Last change:
Date: 4 years ago
Size: 931 bytes
 

Contents

Class file image Download
.. _cli: Command line tool ================= API documentation can easily be generated with the shipped command line tool `phpdoc-to-rst`. .. code:: Usage: phpdoc-to-rst generate <target> [<src>]... Arguments: target Destination for the generated rst files src Source directories to parse Options: -h, --help Display this help message -q, --quiet Do not output any message -V, --version Display this application version --ansi Force ANSI output --no-ansi Disable ANSI output -n, --no-interaction Do not ask any interactive question -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug Help: This command allows you to generate sphinx/rst based documentation from PHPDoc annotations.