Skip to main content

sample implementation of phpdocumentor using sphinx

Project description


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


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

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

That’s all.



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


.. phpautomodule::
   :filename: path/to/source_code.php


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


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

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


.. phpautoclass::
   :filename: path/to/source_code.php


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.

Filename, size & hash SHA256 hash help File type Python version Upload date
tk.phpautodoc-1.1.1.tar.gz (25.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page