Metadata-Version: 2.4
Name: sphinxcontrib-phpdomain
Version: 0.15.1
Summary: Sphinx extension to enable documenting PHP code
Author-email: Mark Story <mark@mark-story.com>, Michael Voříšek <mvorisek@mvorisek.cz>
License: If not otherwise noted, the extensions in this package are licensed
        under the following license.
        
        Copyright (c) 2016 by Mark Story and contributors.
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are
        met:
        
        * Redistributions of source code must retain the above copyright
          notice, this list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright
          notice, this list of conditions and the following disclaimer in the
          documentation and/or other materials provided with the distribution.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
        "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
        LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
        A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
        OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
        SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
        LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
        DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
        THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
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: License :: OSI Approved :: BSD License
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
* 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

