{
    "info": {
        "author": "Jani Nikula",
        "author_email": "jani@nikula.org",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Framework :: Sphinx :: Extension",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3",
            "Topic :: Documentation :: Sphinx",
            "Topic :: Software Development :: Documentation"
        ],
        "description": "Hawkmoth - Sphinx Autodoc for C\n===============================\n\nHawkmoth is a minimalistic Sphinx_ `C Domain`_ autodoc directive extension to\nincorporate formatted C source code comments written in reStructuredText_ into\nSphinx based documentation. It uses Clang Python Bindings for parsing, and\ngenerates C Domain directives for C API documentation, and more. In short,\nHawkmoth is Sphinx Autodoc for C.\n\nHawkmoth aims to be a compelling alternative for documenting C projects using\nSphinx, mainly through its simplicity of design, implementation and use.\n\n.. _Sphinx: http://www.sphinx-doc.org\n\n.. _C Domain: http://www.sphinx-doc.org/en/stable/domains.html\n\n.. _reStructuredText: http://docutils.sourceforge.net/rst.html\n\nExample\n-------\n\nGiven C source code with rather familiar looking documentation comments::\n\n  /**\n   * Get foo out of bar.\n   */\n  void foobar();\n\nand a directive in the Sphinx project::\n\n  .. c:autodoc:: filename.c\n\nyou can incorporate code documentation into Sphinx. It's as simple as that.\n\nYou can document functions, their parameters and return values, structs, unions,\ntheir members, macros, function-like macros, enums, enumeration constants,\ntypedefs, variables, as well as have generic documentation comments not attached\nto any symbols.\n\nDocumentation\n-------------\n\nDocumentation on how to configure Hawkmoth and write documentation comments,\nwith examples, is available in the ``doc`` directory in the source tree,\nobviously in Sphinx format and using the directive extension. Pre-built\ndocumentation `showcasing what Hawkmoth can do`_ is available at `Read the\nDocs`_.\n\n.. _showcasing what Hawkmoth can do: https://hawkmoth.readthedocs.io/en/latest/examples.html\n\n.. _Read the Docs: https://hawkmoth.readthedocs.io/\n\nInstallation\n------------\n\nYou can install Hawkmoth from PyPI_ with::\n\n  pip install hawkmoth\n\nYou'll additionally need to install Clang and Python 3 bindings for it through\nyour distro's package manager; they are not available via PyPI. You may also\nneed to set ``LD_LIBRARY_PATH`` so that the Clang library can be found. For\nexample::\n\n  export LD_LIBRARY_PATH=$(llvm-config --libdir)\n\nAlternatively, installation packages are available for:\n\n* `Arch Linux`_\n\nIn Sphinx ``conf.py``, add ``hawkmoth`` to ``extensions``, and point\n``cautodoc_root`` at the source tree. See the extension documentation for\ndetails.\n\n.. _PyPI: https://pypi.org/project/hawkmoth/\n\n.. _Arch Linux: https://aur.archlinux.org/packages/?K=hawkmoth\n\nDevelopment and Contributing\n----------------------------\n\nHawkmoth source code is available on GitHub_. The development version can be\nchecked out via ``git`` using this command::\n\n  git clone https://github.com/jnikula/hawkmoth.git\n\nPlease file bugs and feature requests as GitHub issues. Contributions are\nwelcome both as emailed patches to the mailing list and as pull requests.\n\n.. _GitHub: https://github.com/jnikula/hawkmoth\n\nDependencies\n------------\n\n- Python 3.4\n- Sphinx 1.8\n- Clang 6.0\n- Python 3 Bindings for Clang 6.0\n- sphinx-testing 1.0.0 (for development)\n\nThese are the versions Hawkmoth is currently being developed and tested\nagainst. Other versions might work, but no guarantees.\n\nLicense\n-------\n\nHawkmoth is free software, released under the `2-Clause BSD License`_.\n\n.. _2-Clause BSD License: https://opensource.org/licenses/BSD-2-Clause\n\nContact\n-------\n\nIRC channel ``#hawkmoth`` on freenode_.\n\nMailing list hawkmoth@freelists.org. Subscription information at the `list home\npage`_.\n\n.. _freenode: https://freenode.net/\n\n.. _list home page: https://www.freelists.org/list/hawkmoth\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/jnikula/hawkmoth",
        "keywords": "python sphinx autodoc documentation c",
        "license": "2-Clause BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "hawkmoth",
        "package_url": "https://pypi.org/project/hawkmoth/",
        "platform": "",
        "project_url": "https://pypi.org/project/hawkmoth/",
        "project_urls": {
            "Documentation": "https://hawkmoth.readthedocs.io/en/latest/",
            "Homepage": "https://github.com/jnikula/hawkmoth",
            "Mailing List": "https://www.freelists.org/list/hawkmoth"
        },
        "release_url": "https://pypi.org/project/hawkmoth/0.4/",
        "requires_dist": [
            "sphinx",
            "sphinx-testing ; extra == 'dev'"
        ],
        "requires_python": "~=3.4",
        "summary": "Hawkmoth - Sphinx Autodoc for C",
        "version": "0.4"
    },
    "last_serial": 5374991,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6e9c151168e4e228cf3508b98b447a54",
                    "sha256": "1642c9745995a3e9fe51726c8593cbd41727df303b67e5f2247b9fbbdaceb400"
                },
                "downloads": -1,
                "filename": "hawkmoth-0.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "6e9c151168e4e228cf3508b98b447a54",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3",
                "size": 9394,
                "upload_time": "2018-12-13T12:29:20",
                "url": "https://files.pythonhosted.org/packages/39/09/21f8c1a5a6806dc6619e941fc7ff44b1dee07ef77e22b37fdc2621378f80/hawkmoth-0.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "abfe591ee6b945fdec122f6965930e7b",
                    "sha256": "57fd6f55acb56e703a4cf213ab590ce43c46362db742b0b45cf83de9b7b2ad46"
                },
                "downloads": -1,
                "filename": "hawkmoth-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "abfe591ee6b945fdec122f6965930e7b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 8151,
                "upload_time": "2018-12-13T12:29:22",
                "url": "https://files.pythonhosted.org/packages/f9/95/0fabddf21ba6312eeb5d82a6b1eb25762b8824bd17619cd7c5de434e1ae1/hawkmoth-0.1.0.tar.gz"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c52a04518aa1f047326d32fdeb26b477",
                    "sha256": "fd9daec667d821d8dabab3ac50a329251dbde93ed75715355e3d62e41c510594"
                },
                "downloads": -1,
                "filename": "hawkmoth-0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c52a04518aa1f047326d32fdeb26b477",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": "~=3.4",
                "size": 9394,
                "upload_time": "2019-01-26T19:22:28",
                "url": "https://files.pythonhosted.org/packages/b1/c2/b5b90ce84400c311901f8b8e67e73472e644a8535bbdafefbd08d994da99/hawkmoth-0.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "cf582558444558f17a686b3bd7c821b7",
                    "sha256": "cec32577f5f8744224f97ddaa3a7b637eb221bc7e86589ae1c769c713076293e"
                },
                "downloads": -1,
                "filename": "hawkmoth-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "cf582558444558f17a686b3bd7c821b7",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": "~=3.4",
                "size": 9296,
                "upload_time": "2019-01-26T19:22:29",
                "url": "https://files.pythonhosted.org/packages/e7/b3/ada2c0b3bb9efa0ee693bb7b2ad58dd1d0b7d6d36dbacc3977bb95bdbb8c/hawkmoth-0.2.tar.gz"
            }
        ],
        "0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ad6e07724456a6636e6655df527606f5",
                    "sha256": "615c24c26d05e69affc93ef7f9bcfdb9b0b8b1f4a9788fdb172d67b14a441b31"
                },
                "downloads": -1,
                "filename": "hawkmoth-0.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ad6e07724456a6636e6655df527606f5",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": "~=3.4",
                "size": 12394,
                "upload_time": "2019-01-29T22:21:30",
                "url": "https://files.pythonhosted.org/packages/c2/ae/182790c0e95aaf2a9e71b932e07423ffbf5cb20587f8816968a695eb1bd8/hawkmoth-0.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "7a1edb03a688eb7f70a506be1b9f63e4",
                    "sha256": "05349958addd8341cd5048b1a4a11d13d3f74ad0225bd8fe5bd914757ea738f6"
                },
                "downloads": -1,
                "filename": "hawkmoth-0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "7a1edb03a688eb7f70a506be1b9f63e4",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": "~=3.4",
                "size": 12728,
                "upload_time": "2019-01-29T22:21:32",
                "url": "https://files.pythonhosted.org/packages/f6/5f/6260b0f4bf4604ceddcc32f321f2b09b4dc98282bed8ab009fc581e7bcdd/hawkmoth-0.3.tar.gz"
            }
        ],
        "0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0e8ce77d8d2626790b8c7f51bb576ef8",
                    "sha256": "a1d4e30f8e711ce33f48787676600d3349fa6192b9577f34fde529641eb8b937"
                },
                "downloads": -1,
                "filename": "hawkmoth-0.4-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "0e8ce77d8d2626790b8c7f51bb576ef8",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": "~=3.4",
                "size": 12904,
                "upload_time": "2019-06-08T09:52:12",
                "url": "https://files.pythonhosted.org/packages/79/a4/f498abf111601bf16d6a2580162178c449ae6fa03ae48ec14e31c8fbf583/hawkmoth-0.4-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "aab6cd2df9d1f58125a1f766548ad854",
                    "sha256": "bb2176f403e51c531073c80b57453b6541e71c19afe8f2b77732287dd5d9bfc7"
                },
                "downloads": -1,
                "filename": "hawkmoth-0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "aab6cd2df9d1f58125a1f766548ad854",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": "~=3.4",
                "size": 13407,
                "upload_time": "2019-06-08T09:52:13",
                "url": "https://files.pythonhosted.org/packages/70/d0/cbc2f07572ff029bfbc544082f86d49e0c0bcaf0345aa65e120b3fc0f508/hawkmoth-0.4.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "0e8ce77d8d2626790b8c7f51bb576ef8",
                "sha256": "a1d4e30f8e711ce33f48787676600d3349fa6192b9577f34fde529641eb8b937"
            },
            "downloads": -1,
            "filename": "hawkmoth-0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0e8ce77d8d2626790b8c7f51bb576ef8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.4",
            "size": 12904,
            "upload_time": "2019-06-08T09:52:12",
            "url": "https://files.pythonhosted.org/packages/79/a4/f498abf111601bf16d6a2580162178c449ae6fa03ae48ec14e31c8fbf583/hawkmoth-0.4-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "aab6cd2df9d1f58125a1f766548ad854",
                "sha256": "bb2176f403e51c531073c80b57453b6541e71c19afe8f2b77732287dd5d9bfc7"
            },
            "downloads": -1,
            "filename": "hawkmoth-0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "aab6cd2df9d1f58125a1f766548ad854",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.4",
            "size": 13407,
            "upload_time": "2019-06-08T09:52:13",
            "url": "https://files.pythonhosted.org/packages/70/d0/cbc2f07572ff029bfbc544082f86d49e0c0bcaf0345aa65e120b3fc0f508/hawkmoth-0.4.tar.gz"
        }
    ]
}