{ "info": { "author": "Robert T. McGibbon", "author_email": "rmcgibbo@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "=============================\nsphinxcontrib-autodoc_doxygen\n=============================\n\n.. image:: https://travis-ci.org/rmcgibbo/sphinxcontrib-autodoc_doxygen.svg?branch=master\n :target: https://travis-ci.org/rmcgibbo/sphinxcontrib-autodoc_doxygen\n\n`Example Output `_\n\nThis a (pre-alpha) extension for sphinx that to read and display Doxygen XML output. It is similar to\nBreathe. The implementation extends ``sphinx.ext.autodoc`` and ``sphinx.ext.autosummary`` as closely as\npossble.\n\nUsage\n-----\nIn your Sphinx ``conf.py`` add ``'sphinxcontrib.autodoc_doxygen'`` to the list of extensions, and set the\nvariable ``doxygen_xml`` to a string containing the path to the directory containing your Doxygen XML\noutput.\n\nThis adds the following RST directives. ::\n\n autodoxysummary\n autodoxyclass\n autodoxymethod\n autodoxyenum\n\nExamples\n--------\n\n::\n\n .. autodoxysummary::\n :toctree: generated/\n :template: doxyclass.rst\n\n OpenMM::CustomIntegrator\n OpenMM::CustomCompoundBondForce\n\nThis produces the output shown `here `_\n\n\nInstallation\n------------\nYou can install it with pip (py27 or py33+)::\n\n pip install sphinxcontrib-autodoc_doxygen\n \nThe necessary dependences should be grabbed by ``pip``. If you have trouble getting lxml,\nhere are some tips:\n\nIf you use the `Anaconda `_ Python\ndistribution, run ``conda install lxml``. With the system package manager on linux,\n``sudo apt-get install python-lxml`` or ``sudo yum install python-lxml`` should do the trick.\nOn Windows, you may be able to download the lxml from `Christoph Gohlke's repository\n`_. On OS X, try the following long command\n``brew install libxslt libxml2; LDFLAGS=\"-L/usr/local/opt/libxslt/lib -L/usr/local/opt/libxml2/lib\" CPPFLAGS=\"-I/usr/local/opt/libxml2/include -I/usr/local/opt/libxslt/include\" pip install lxml``. It may take a\nlong time (~5 minutes), but once the wheel is built, it will be cache, so you only need\nto do this once, even if switch virtualenvs.", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/rmcgibbo/sphinxcontrib-autodoc_doxygen", "keywords": "sphinx", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-autodoc_doxygen", "package_url": "https://pypi.org/project/sphinxcontrib-autodoc_doxygen/", "platform": "", "project_url": "https://pypi.org/project/sphinxcontrib-autodoc_doxygen/", "project_urls": { "Homepage": "https://github.com/rmcgibbo/sphinxcontrib-autodoc_doxygen" }, "release_url": "https://pypi.org/project/sphinxcontrib-autodoc_doxygen/0.3.2/", "requires_dist": null, "requires_python": "", "summary": "Doxygen / Sphinx bridge, with autodoc and autosummary", "version": "0.3.2" }, "last_serial": 2543286, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "f0ed81cab02dcf85ba0a46d2fdfe56a6", "sha256": "f958b39938420b044423600c6d802bd2cbfdd978b70683a62fd1ad1b356677b6" }, "downloads": -1, "filename": "sphinxcontrib_autodoc_doxygen-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f0ed81cab02dcf85ba0a46d2fdfe56a6", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 14554, "upload_time": "2015-11-22T01:22:51", "url": "https://files.pythonhosted.org/packages/ff/83/509126b1e33a81d06773df1ab82936d31c6446386afece60fc6a22999b71/sphinxcontrib_autodoc_doxygen-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "40852eb41fecddc92c39662a69aaca7b", "sha256": "005da555be15061779431e9432e36d64a12d77a669b401f987cec520f0751472" }, "downloads": -1, "filename": "sphinxcontrib-autodoc_doxygen-0.1.0.tar.gz", "has_sig": false, "md5_digest": "40852eb41fecddc92c39662a69aaca7b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 249146, "upload_time": "2015-11-22T01:19:31", "url": "https://files.pythonhosted.org/packages/e9/b8/30277a0b44a5fe18f2a015b23cbfdab9ddcf753dba80a4257ae056d797a7/sphinxcontrib-autodoc_doxygen-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "ccd65368101dd5943bb5335a1f3894ba", "sha256": "c0e4d9e6534c0d483cf3bc048389bc6d80f3246e070e2ff8f0d375d60064b562" }, "downloads": -1, "filename": "sphinxcontrib_autodoc_doxygen-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ccd65368101dd5943bb5335a1f3894ba", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16060, "upload_time": "2015-12-04T09:58:47", "url": "https://files.pythonhosted.org/packages/44/2b/ac0cdb44227475f43f07c16101dada77dfa2b1f3ed3a4ab11a4e0a9761a0/sphinxcontrib_autodoc_doxygen-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "733ce34a0ba708ecab22f6590e519fd0", "sha256": "eb63da8abb3752d2369c07d28fbde6814178b5aae3f84cd312569afd8fa4694a" }, "downloads": -1, "filename": "sphinxcontrib-autodoc_doxygen-0.2.0.tar.gz", "has_sig": false, "md5_digest": "733ce34a0ba708ecab22f6590e519fd0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 250687, "upload_time": "2015-12-04T09:58:53", "url": "https://files.pythonhosted.org/packages/8a/0e/ed0c35770637ca131500c35122162095b103d1efdc99230306918cf9fd1c/sphinxcontrib-autodoc_doxygen-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "dd353298a18dc42eaef10e577e376e90", "sha256": "f34285890800ba69f796b74d29afad0a38c9a8634d84200673577952d5094b62" }, "downloads": -1, "filename": "sphinxcontrib_autodoc_doxygen-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "dd353298a18dc42eaef10e577e376e90", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16113, "upload_time": "2015-12-14T21:54:47", "url": "https://files.pythonhosted.org/packages/3f/be/04fdbd6eef19ee39317c3aeb97a5e3b9cdc69990005a888ae150ee962f9b/sphinxcontrib_autodoc_doxygen-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f7260b07d2d61e75dc048119f7e94915", "sha256": "e3b08455c9b0f03b2c96bdbb85582ddf425794bc27e43bb12aa6fc89ba504cba" }, "downloads": -1, "filename": "sphinxcontrib-autodoc_doxygen-0.3.0.tar.gz", "has_sig": false, "md5_digest": "f7260b07d2d61e75dc048119f7e94915", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 251189, "upload_time": "2015-12-14T21:54:54", "url": "https://files.pythonhosted.org/packages/f1/46/8413f33c21f1c0c543967408187f8d32000322f1d142e688ca21eb96d39f/sphinxcontrib-autodoc_doxygen-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "cd5d39a4e2d40ed652fb7eb8fd9a1f55", "sha256": "555911d19dc43b2c005a9168b7ea619e94b98d5a39f71b47d84191f1b59d93eb" }, "downloads": -1, "filename": "sphinxcontrib_autodoc_doxygen-0.3.1-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "cd5d39a4e2d40ed652fb7eb8fd9a1f55", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 16273, "upload_time": "2015-12-16T21:56:42", "url": "https://files.pythonhosted.org/packages/44/8b/c33bd450cdd9d158843e8a8f9a805f19c42d5ba128b4a6a51ca3b70462b3/sphinxcontrib_autodoc_doxygen-0.3.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fcfbc77a810900865b143b7aa9409e2f", "sha256": "d11b10c5da5308206e56b1bcf1e26839f47f5c2bcb5c48c12664ce2386218a68" }, "downloads": -1, "filename": "sphinxcontrib-autodoc_doxygen-0.3.1.tar.gz", "has_sig": true, "md5_digest": "fcfbc77a810900865b143b7aa9409e2f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 252768, "upload_time": "2015-12-16T21:56:19", "url": "https://files.pythonhosted.org/packages/c1/dc/12229bef5a50338f3ed023fdfc87050cc98eb2d0d5327d4f8e9adf85f96c/sphinxcontrib-autodoc_doxygen-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "9cf1b9041ee3da4d2c351121f07a4ece", "sha256": "d7257e5b4f515d4c803b069e51c3a0e2328881a2c9a2a973c14f931b2adeecd9" }, "downloads": -1, "filename": "sphinxcontrib_autodoc_doxygen-0.3.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9cf1b9041ee3da4d2c351121f07a4ece", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16324, "upload_time": "2016-12-28T22:49:18", "url": "https://files.pythonhosted.org/packages/16/da/fedeb9e8b6d7110cf0575d0882a5550e8668a880046c588330eefd2af2e8/sphinxcontrib_autodoc_doxygen-0.3.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "14c07fb345ba0d57e57236b5b484d13a", "sha256": "cc13ca218db2907c9e3cb530d21b5a7ab6c17502958b931b3e1b82b506497e1a" }, "downloads": -1, "filename": "sphinxcontrib-autodoc_doxygen-0.3.2.tar.gz", "has_sig": false, "md5_digest": "14c07fb345ba0d57e57236b5b484d13a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 252774, "upload_time": "2016-12-28T22:49:01", "url": "https://files.pythonhosted.org/packages/c0/4c/adf0ede4585e51b4810c4b649f46781d8550792167bb4873ed9b76d3bfcb/sphinxcontrib-autodoc_doxygen-0.3.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9cf1b9041ee3da4d2c351121f07a4ece", "sha256": "d7257e5b4f515d4c803b069e51c3a0e2328881a2c9a2a973c14f931b2adeecd9" }, "downloads": -1, "filename": "sphinxcontrib_autodoc_doxygen-0.3.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9cf1b9041ee3da4d2c351121f07a4ece", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16324, "upload_time": "2016-12-28T22:49:18", "url": "https://files.pythonhosted.org/packages/16/da/fedeb9e8b6d7110cf0575d0882a5550e8668a880046c588330eefd2af2e8/sphinxcontrib_autodoc_doxygen-0.3.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "14c07fb345ba0d57e57236b5b484d13a", "sha256": "cc13ca218db2907c9e3cb530d21b5a7ab6c17502958b931b3e1b82b506497e1a" }, "downloads": -1, "filename": "sphinxcontrib-autodoc_doxygen-0.3.2.tar.gz", "has_sig": false, "md5_digest": "14c07fb345ba0d57e57236b5b484d13a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 252774, "upload_time": "2016-12-28T22:49:01", "url": "https://files.pythonhosted.org/packages/c0/4c/adf0ede4585e51b4810c4b649f46781d8550792167bb4873ed9b76d3bfcb/sphinxcontrib-autodoc_doxygen-0.3.2.tar.gz" } ] }