Skip to main content

API Documentation generator for PHP projects which use Sphinx.

Project description

# doxyphp2sphinx

API Documentation generator for PHP projects which use Sphinx.

It acts as a compatibility layer between Doxygen (which is good at reading PHP),
and Sphinx (which is used by some online services to host HTML docs).


This tool is compatible with Python 2 and 3.

## Installation

### From source

git clone
python bdist_wheel --universal
pip install dist/doxyphp2sphinx-*.whl

### From pip

pip install doxyphp2sphinx

### Verification

Test that you have the command.

doxyphp2sphinx --help

## Command-line use

This package provides the `doxyphp2sphinx` command, which generates `.rst` files as output, given a directory
of `doxygen` XML files.

usage: doxyphp2sphinx [-h] [--xml-dir XML_DIR] [--out-dir OUT_DIR] [--verbose]

Generate Sphinx-ready reStructuredText documentation or your PHP project,
using Doxygen XML as an input.

positional arguments:

optional arguments:
-h, --help show this help message and exit
--xml-dir XML_DIR directory to read from
--out-dir OUT_DIR directory to write to
--verbose, -v more output
--quiet, -q less output

## Example

The `gfx-php` project uses this tool to publish documentation to [](, so
we'll use that as an example:

- Code:
- Docs:

git clone
cd docs
doxyphp2sphinx Mike42::GfxPhp
make html

## License

doxyphp2sphinx is released under a BSD 2-Clause License. See LICENSE for the full text.

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 doxyphp2sphinx, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size doxyphp2sphinx-1.0.1-py2.py3-none-any.whl (10.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page