{ "info": { "author": "Juan I Carrano ", "author_email": "juan@carrano.com.ar", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Framework :: Sphinx :: Extension", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Programming Language :: Python :: 3", "Topic :: Documentation :: Sphinx", "Topic :: Software Development :: Documentation" ], "description": "==============================================\nAntidox: Use Doxygen sanely from within Sphinx\n==============================================\n\n---------------------------\nAn antidote to doxy-madness\n---------------------------\n\n|docs| |pypi|\n\n\nSummary\n=======\n\n``antidox`` is a Sphinx_ extension that can read Doxygen_ XML \"databases\" and\ninsert documentation for entities in Sphinx documents, similar to Breathe_.\n\nIt is intended to be *fast* and simple, though *easily customizable*.\n\nDocument generation (i.e. conversion between doxy-xml and reStructuredText) is\ndriven by XML stylesheets (powered by lxml_,) while indexing and selection of\ndocumentable entities is done by a SQL database (sqlite3_.)\n\nHere is an `example project `_ showing showing this extension in\naction.\n\nNote: Beta\n==========\n\nThough usable, this extension is still under development. Backwards\ncompatibility will be kept for all releases with the same major/minor version.\n\nBe aware, however, that after updating this extension you may need to do a clean\nbuild of your docs to see the results.\n\nObjectives\n==========\n\n* Reuse API docs made with Doxygen in a Sphinx project.\n* Provide a smooth transition between 100% automatic API docs (what Doxygen\n generates) and semi-manual documentation (autodoc-style).\n* Have sensible defaults for automatic documentation generation while allowing\n customization.\n* Deal with big projects efficiently: the main tool in use now (Breathe)\n has resource usage issues when dealing with large XML files.\n\n.. |docs| image:: https://readthedocs.org/projects/antidox/badge/?version=latest&style=for-the-badge\n :alt: Documentation Status\n :scale: 100%\n :target: https://antidox.readthedocs.io/en/latest/?badge=latest\n\n.. |pypi| image:: https://img.shields.io/pypi/v/antidox.svg?style=for-the-badge\n :alt: PyPI\n :scale: 200%\n :target: https://pypi.org/project/antidox/\n\n.. _Sphinx: https://www.sphinx-doc.org\n.. _Doxygen: http://www.doxygen.nl/\n.. _Breathe: https://breathe.readthedocs.io/en/latest/\n.. _lxml: https://lxml.de/\n.. _sqlite3: https://docs.python.org/3/library/sqlite3.html\n.. _cbor_example: https://antidox-example.readthedocs.io/en/latest/\n\n\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jcarrano/antidox", "keywords": "sphinx doxygen", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "antidox", "package_url": "https://pypi.org/project/antidox/", "platform": "", "project_url": "https://pypi.org/project/antidox/", "project_urls": { "Documentation": "https://antidox.readthedocs.io/en/latest/index.html", "Homepage": "https://github.com/jcarrano/antidox", "Tracker": "https://github.com/jcarrano/antidox/issues" }, "release_url": "https://pypi.org/project/antidox/0.1.3/", "requires_dist": [ "sphinx", "lxml" ], "requires_python": "", "summary": "Sphinx extension to extract and insert Doxygen documentation.", "version": "0.1.3" }, "last_serial": 5826452, "releases": { "0.1.2": [ { "comment_text": "", "digests": { "md5": "b7544b87cd68e24a7960ebfbbd50f92e", "sha256": "83b79f06060ada830b561f98946742b83b5426fb5f601874cc5a81b23d84c68b" }, "downloads": -1, "filename": "antidox-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "b7544b87cd68e24a7960ebfbbd50f92e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 34572, "upload_time": "2019-04-26T16:28:44", "url": "https://files.pythonhosted.org/packages/ff/06/85e0dc9a1514716044d67ae2b13b8b56a93e5f568e9f6f68b644675fb2b2/antidox-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "327942730091641107660c5ace645541", "sha256": "b2a280cd09c8d4acc432fd03148c5e6125d35e91542bfdb0596b73933ddf9237" }, "downloads": -1, "filename": "antidox-0.1.2.tar.gz", "has_sig": false, "md5_digest": "327942730091641107660c5ace645541", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31791, "upload_time": "2019-04-26T16:28:59", "url": "https://files.pythonhosted.org/packages/51/8b/ec8cb801995615ae4513cd09330c3d78c9f78237223c3d021efa9f81bf5c/antidox-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "9b27d45d031990f230d783d733ed775c", "sha256": "05c3d6813c0d6a3b8cf4f5380c4674a6d816f59172e341c879d846c0466b6906" }, "downloads": -1, "filename": "antidox-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "9b27d45d031990f230d783d733ed775c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 34608, "upload_time": "2019-09-13T15:51:20", "url": "https://files.pythonhosted.org/packages/87/d5/89c89465ae1b80845e728b67f3c8badb4af5665b751b931e8e3ed906816b/antidox-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fd4746bf82496c616450e07332e78f90", "sha256": "27d939cc5a881fd7c0711558ecf6e64e48c1aa36cbbae33f60bdcfd33eda2617" }, "downloads": -1, "filename": "antidox-0.1.3.tar.gz", "has_sig": false, "md5_digest": "fd4746bf82496c616450e07332e78f90", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31865, "upload_time": "2019-09-13T15:51:21", "url": "https://files.pythonhosted.org/packages/63/41/f54c0173cc7d04e7e9cc436284f61b7895c3d472c1334a5185d8d4097ab0/antidox-0.1.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9b27d45d031990f230d783d733ed775c", "sha256": "05c3d6813c0d6a3b8cf4f5380c4674a6d816f59172e341c879d846c0466b6906" }, "downloads": -1, "filename": "antidox-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "9b27d45d031990f230d783d733ed775c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 34608, "upload_time": "2019-09-13T15:51:20", "url": "https://files.pythonhosted.org/packages/87/d5/89c89465ae1b80845e728b67f3c8badb4af5665b751b931e8e3ed906816b/antidox-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fd4746bf82496c616450e07332e78f90", "sha256": "27d939cc5a881fd7c0711558ecf6e64e48c1aa36cbbae33f60bdcfd33eda2617" }, "downloads": -1, "filename": "antidox-0.1.3.tar.gz", "has_sig": false, "md5_digest": "fd4746bf82496c616450e07332e78f90", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31865, "upload_time": "2019-09-13T15:51:21", "url": "https://files.pythonhosted.org/packages/63/41/f54c0173cc7d04e7e9cc436284f61b7895c3d472c1334a5185d8d4097ab0/antidox-0.1.3.tar.gz" } ] }