https://github.com/mike42/doxyphp2sphinx
API Documentation generator for PHP priojects which use Sphinx.
https://github.com/mike42/doxyphp2sphinx
documentation doxygen php readthedocs restructuredtext sphinx
Last synced: 8 months ago
JSON representation
API Documentation generator for PHP priojects which use Sphinx.
- Host: GitHub
- URL: https://github.com/mike42/doxyphp2sphinx
- Owner: mike42
- License: bsd-2-clause
- Created: 2018-05-17T20:18:23.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-02-11T02:51:40.000Z (over 5 years ago)
- Last Synced: 2025-09-25T12:46:11.523Z (9 months ago)
- Topics: documentation, doxygen, php, readthedocs, restructuredtext, sphinx
- Language: Python
- Size: 14.6 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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).
- http://www.sphinx-doc.org/en/master/
- http://www.doxygen.org/
This tool is compatible with Python 2 and 3.
## Installation
### From source
```bash
git clone https://github.com/mike42/
python setup.py bdist_wheel --universal
pip install dist/doxyphp2sphinx-*.whl
```
### From pip
```bash
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.
```bash
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
```
## Example
The `gfx-php` project uses this tool to publish documentation to [readthedocs.org](https://readthedocs.org/), so
we'll use that as an example:
- Code: https://github.com/mike42/gfx-php
- Docs: https://gfx-php.readthedocs.io
```
git clone https://github.com/mike42/gfx-php
cd docs
doxygen
doxyphp2sphinx Mike42::GfxPhp
make html
```
## License
doxyphp2sphinx is released under a BSD 2-Clause License. See LICENSE for the full text.