{ "info": { "author": "Arto Bendiken", "author_email": "arto@bendiken.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: Public Domain", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "*********************\nsphinxcontrib-cheader\n*********************\n\nThis is a Sphinx_ extension that implements the ``c:header`` directive that\nis inadvertently absent from Sphinx's built-in `C domain`_. It works\nsimilarly to the built-in ``py:module`` directive.\n\n.. _Sphinx: http://sphinx-doc.org/\n.. _C domain: http://sphinx-doc.org/domains.html#the-c-domain\n\nExamples\n========\n\nAt the beginning of the description of a header file in your documentation,\ninsert a corresponding ``c:header`` directive as follows::\n\n .. c:header:: \n\nThe aforementioned creates an index entry of: `libfoobar.h (C header)`.\n\nFor a real usage example, see the http://libcpr.org documentation.\nThe corresponding Sphinx sources can be found at:\nhttps://github.com/dryproject/libcpr/tree/master/doc/manual\n\nInstallation\n============\n\nRefer to the `PyPI Tutorial`_ for installation instructions. If you have a\nmodern Python environment, installation should be as easy as::\n\n $ sudo pip install sphinxcontrib-cheader\n\n.. _PyPI Tutorial: https://wiki.python.org/moin/CheeseShopTutorial\n\nConfiguration\n=============\n\nTo enable the extension, edit your Sphinx ``conf.py`` configuration file to\ninclude the extension name in the ``extensions`` list; for example::\n\n extensions = ['sphinxcontrib.cheader']\n\nAuthor\n======\n\n`Arto Bendiken `_ - http://ar.to/\n\nLicense\n=======\n\nThis is free and unencumbered public domain software. For more information,\nsee http://unlicense.org/ or the accompanying ``LICENSE`` file.", "description_content_type": null, "docs_url": null, "download_url": "http://pypi.python.org/pypi/sphinxcontrib-cheader", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://bitbucket.org/birkenfeld/sphinx-contrib", "keywords": null, "license": "Public Domain", "maintainer": null, "maintainer_email": null, "name": "sphinxcontrib-cheader", "package_url": "https://pypi.org/project/sphinxcontrib-cheader/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-cheader/", "project_urls": { "Download": "http://pypi.python.org/pypi/sphinxcontrib-cheader", "Homepage": "http://bitbucket.org/birkenfeld/sphinx-contrib" }, "release_url": "https://pypi.org/project/sphinxcontrib-cheader/1.0.0/", "requires_dist": null, "requires_python": null, "summary": "Sphinx c:header directive", "version": "1.0.0" }, "last_serial": 1301749, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "00acc78d02115bfe11cc686fde94b99d", "sha256": "1690019d40f74e3de250ae3bc0f6beec2d3c870c648d1b8bdb6c8aab56ef40ac" }, "downloads": -1, "filename": "sphinxcontrib-cheader-1.0.0.tar.gz", "has_sig": false, "md5_digest": "00acc78d02115bfe11cc686fde94b99d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3122, "upload_time": "2014-11-10T23:41:32", "url": "https://files.pythonhosted.org/packages/02/c8/ca56402f5e3eb7744c87d9ad502f929948db0cb0728ff2d33c33640bac2c/sphinxcontrib-cheader-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "00acc78d02115bfe11cc686fde94b99d", "sha256": "1690019d40f74e3de250ae3bc0f6beec2d3c870c648d1b8bdb6c8aab56ef40ac" }, "downloads": -1, "filename": "sphinxcontrib-cheader-1.0.0.tar.gz", "has_sig": false, "md5_digest": "00acc78d02115bfe11cc686fde94b99d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3122, "upload_time": "2014-11-10T23:41:32", "url": "https://files.pythonhosted.org/packages/02/c8/ca56402f5e3eb7744c87d9ad502f929948db0cb0728ff2d33c33640bac2c/sphinxcontrib-cheader-1.0.0.tar.gz" } ] }