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

A PHP domain for sphinx. Allows you to annotate PHP objects in your sphinx docs.
https://github.com/markstory/sphinxcontrib-phpdomain

php python sphinx-documentation

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/markstory/sphinxcontrib-phpdomain
• Owner: markstory
• License: other
• Created: 2016-06-18T15:30:06.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2026-02-22T04:08:00.000Z (4 months ago)
• Last Synced: 2026-02-22T11:17:33.131Z (4 months ago)
• Topics: php, python, sphinx-documentation
• Language: HTML
• Size: 287 KB
• Stars: 20
• Watchers: 2
• Forks: 14
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES
  • License: LICENSE

Awesome Lists containing this project

README

          
PHP Domain for Sphinx

#####################

:author: Mark Story 

: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.

.. _`Usage Example`: https://markstory.github.io/sphinxcontrib-phpdomain/usage.html

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