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.
git clone https://github.com/mike42/ python setup.py bdist_wheel --universal pip install dist/doxyphp2sphinx-*.whl
pip install doxyphp2sphinx
Test that you have the command.
This package provides the
doxyphp2sphinx command, which generates
.rst files as output, given a directory
doxygen XML files.
usage: doxyphp2sphinx [-h] [--xml-dir XML_DIR] [--out-dir OUT_DIR] [--verbose] [--quiet] root_namespace Generate Sphinx-ready reStructuredText documentation or your PHP project, using Doxygen XML as an input. positional arguments: root_namespace 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
gfx-php project uses this tool to publish documentation to readthedocs.org, so
we'll use that as an example:
git clone https://github.com/mike42/gfx-php cd docs doxygen doxyphp2sphinx Mike42::GfxPhp make html
doxyphp2sphinx is released under a BSD 2-Clause License. See LICENSE for the full text.