Skip to main content
# 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.


Metadata

Release files for doxyphp2sphinx 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for doxyphp2sphinx 1.0.1
File Interpreter ABI Platform Actions
doxyphp2sphinx-1.0.1-py2.py3-none-any.whl Python 3, Python 2 none any Details for doxyphp2sphinx-1.0.1-py2.py3-none-any.whl

Release files / doxyphp2sphinx-1.0.1-py2.py3-none-any.whl

Download URL doxyphp2sphinx-1.0.1-py2.py3-none-any.whl
Size 10.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
42502f3d00bb325e2f9992a078f0ec80057172425c66dc1c8287f411e6167221
BLAKE2b-256 checksum
How to use checksums
c207c0a78d9aea08f8f5946793c6a33a6148771163a1e1ad0abb15a273c64096
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for doxyphp2sphinx 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.1 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page