sphinxcontrib-phpdomain 0.15.2

Sphinx extension to enable documenting PHP code

Author:

Mark Story <mark at mark-story.com>

Author:

Michael Voříšek

About

A domain for sphinx >= 1.3 that provides language support for PHP.

PHP Domain supports following objects:

• Global variable

• Global function

• Constant

• Namespaces

• Class

  • Class constant

  • Instance methods

  • Static methods

  • Properties

• Enum

• Exceptions

Note

This domain expresses methods and attribute names like this:

Class::method_name
Class::$attribute_name

You address classes/functions in namespaces using \ syntax as you would in PHP:

Package\Subpackage\Class

See Usage Example in the documentation for information about how to use it.

URLs

PyPI:

https://pypi.python.org/pypi/sphinxcontrib-phpdomain

Documentation:

https://markstory.github.io/sphinxcontrib-phpdomain/

Install

You can install the phpdomain using pip:

pip install -U sphinxcontrib-phpdomain