Skip to main content

sample implementation of phpdocumentor using sphinx

Project description

tk.phpautodoc

tk.phpautodoc is sphinx extension to embed PHPDocs to sphinx document. It works like sphinx.ext.autodoc.

Setup

Install this package and add ‘sphinxcontrib_phpautodoc’ to extensions list:

# in conf.py
extensions += ['sphinxcontrib.phpdomain', 'sphinxcontrib_phpautodoc']

That’s all.

Directives

phpautomodule

phpautomodule works like automodule directive in sphinx.ext.autodoc. It parses .php file, and then pick up functions, classes and methods to your docs.

ex:

.. phpautomodule::
   :filename: path/to/source_code.php
   :members:
   :undoc-members:

phpautoclass

phpautoclass works like autoclass directive in sphinx.ext.autodoc. It parses .php file, and then pick up classes and their members to your docs.

ex:

.. phpautoclass:: MyClass,MySubClass
   :filename: path/to/source_code.php
   :members:
   :undoc-members:

If you do not specify any class-names, phpautoclass picks up all classes in .php file.

ex:

.. phpautoclass::
   :filename: path/to/source_code.php
   :members:
   :undoc-members:

phpautofunction

phpautofunction works like autofunction directive in sphinx.ext.autodoc. It parses .php file, and then pick up functions to your docs.

ex:

.. phpautofunction:: my_function
   :filename: path/to/source_code.php

LICENSE

Apache License 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for tk.phpautodoc, version 1.2.1
Filename, size File type Python version Upload date Hashes
Filename, size tk.phpautodoc-1.2.1.tar.gz (31.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page