Skip to content

A PHP domain for sphinx. Allows you to annotate PHP objects in your sphinx docs.

License

Notifications You must be signed in to change notification settings

markstory/sphinxcontrib-phpdomain

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

a103f44 · Aug 18, 2023
Aug 18, 2023
Aug 18, 2023
Aug 18, 2023
Aug 18, 2023
Aug 18, 2023
Jul 5, 2023
Aug 18, 2023
Mar 28, 2019
Aug 18, 2023
Jul 3, 2023
Jun 18, 2016
Aug 18, 2023

Repository files navigation

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