sphinxcontrib-phpdomain

Sphinx extension to enable documenting PHP code


Keywords
php, python, sphinx-documentation
License
BSD-3-Clause
Install
pip install sphinxcontrib-phpdomain==0.5.0

Documentation

PHP Domain for Sphinx

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
  • Namespace
    • Function
    • Class
  • Class
    • Class constant
    • Instance methods
    • Static methods
    • Properties

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