Metadata-Version: 2.4
Name: sphinxcontrib-phpdomain
Version: 0.15.2
Summary: Sphinx extension to enable documenting PHP code
Author-email: Mark Story <mark@mark-story.com>, Michael Voříšek <mvorisek@mvorisek.cz>
License-Expression: BSD-2-Clause
Project-URL: Homepage, https://github.com/markstory/sphinxcontrib-phpdomain
Project-URL: Documentation, https://markstory.github.io/sphinxcontrib-phpdomain/
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Framework :: Sphinx :: Domain
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires-Python: >=3.13.5
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: sphinx<10.0,>=1.3
Dynamic: license-file

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

.. _`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

