{ "info": { "author": "Michael Billington", "author_email": "michael.billington@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Framework :: Sphinx", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Documentation", "Topic :: Documentation :: Sphinx", "Topic :: Software Development", "Topic :: Software Development :: Documentation", "Topic :: Utilities" ], "description": "# doxyphp2sphinx\n\nAPI Documentation generator for PHP projects which use Sphinx.\n\nIt acts as a compatibility layer between Doxygen (which is good at reading PHP),\nand Sphinx (which is used by some online services to host HTML docs).\n\n- http://www.sphinx-doc.org/en/master/\n- http://www.doxygen.org/\n\nThis tool is compatible with Python 2 and 3.\n\n## Installation\n\n### From source\n\n```bash\ngit clone https://github.com/mike42/\npython setup.py bdist_wheel --universal\npip install dist/doxyphp2sphinx-*.whl\n```\n\n### From pip\n\n```bash\npip install doxyphp2sphinx\n```\n\n### Verification\n\nTest that you have the command.\n\n```\ndoxyphp2sphinx --help\n```\n\n## Command-line use\n\nThis package provides the `doxyphp2sphinx` command, which generates `.rst` files as output, given a directory\nof `doxygen` XML files.\n\n```bash\nusage: doxyphp2sphinx [-h] [--xml-dir XML_DIR] [--out-dir OUT_DIR] [--verbose]\n [--quiet]\n root_namespace\n\nGenerate Sphinx-ready reStructuredText documentation or your PHP project,\nusing Doxygen XML as an input.\n\npositional arguments:\n root_namespace\n\noptional arguments:\n -h, --help show this help message and exit\n --xml-dir XML_DIR directory to read from\n --out-dir OUT_DIR directory to write to\n --verbose, -v more output\n --quiet, -q less output\n```\n\n## Example\n\nThe `gfx-php` project uses this tool to publish documentation to [readthedocs.org](https://readthedocs.org/), so\nwe'll use that as an example:\n\n- Code: https://github.com/mike42/gfx-php\n- Docs: https://gfx-php.readthedocs.io\n\n```\ngit clone https://github.com/mike42/gfx-php\ncd docs\ndoxygen\ndoxyphp2sphinx Mike42::GfxPhp\nmake html\n```\n\n## License\n\ndoxyphp2sphinx is released under a BSD 2-Clause License. See LICENSE for the full text.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/mike42/doxyphp2sphinx", "keywords": "doxygen sphinx restructuredtext readthedocs php documentation", "license": "", "maintainer": "", "maintainer_email": "", "name": "doxyphp2sphinx", "package_url": "https://pypi.org/project/doxyphp2sphinx/", "platform": "", "project_url": "https://pypi.org/project/doxyphp2sphinx/", "project_urls": { "Bug Reports": "https://github.com/mike42/doxyphp2sphinx/issues", "Homepage": "https://github.com/mike42/doxyphp2sphinx", "Source": "https://github.com/mike42/doxyphp2sphinx" }, "release_url": "https://pypi.org/project/doxyphp2sphinx/1.0.1/", "requires_dist": [ "enum34", "check-manifest; extra == 'dev'", "coverage; extra == 'test'" ], "requires_python": "", "summary": "API Documentation generator for PHP projects which use Sphinx.", "version": "1.0.1" }, "last_serial": 3880246, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "fd0c6de6db233f20af4ed93f3dfddc6e", "sha256": "fbbb0e6f4a890e70a700041a3081209335b27524891e13be4bf18a71161c7105" }, "downloads": -1, "filename": "doxyphp2sphinx-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "fd0c6de6db233f20af4ed93f3dfddc6e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9901, "upload_time": "2018-05-20T02:02:25", "url": "https://files.pythonhosted.org/packages/20/b6/c0db716bee190f248917dd0397bf6c20e804567d60e1bda542119c4a87a7/doxyphp2sphinx-1.0.0-py2.py3-none-any.whl" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "cf98a8af0c0e057877c20926c9c96ec0", "sha256": "42502f3d00bb325e2f9992a078f0ec80057172425c66dc1c8287f411e6167221" }, "downloads": -1, "filename": "doxyphp2sphinx-1.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "cf98a8af0c0e057877c20926c9c96ec0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 10887, "upload_time": "2018-05-20T02:40:16", "url": "https://files.pythonhosted.org/packages/c2/07/c0a78d9aea08f8f5946793c6a33a6148771163a1e1ad0abb15a273c64096/doxyphp2sphinx-1.0.1-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "cf98a8af0c0e057877c20926c9c96ec0", "sha256": "42502f3d00bb325e2f9992a078f0ec80057172425c66dc1c8287f411e6167221" }, "downloads": -1, "filename": "doxyphp2sphinx-1.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "cf98a8af0c0e057877c20926c9c96ec0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 10887, "upload_time": "2018-05-20T02:40:16", "url": "https://files.pythonhosted.org/packages/c2/07/c0a78d9aea08f8f5946793c6a33a6148771163a1e1ad0abb15a273c64096/doxyphp2sphinx-1.0.1-py2.py3-none-any.whl" } ] }