{
    "info": {
        "author": "Paul Ganssle",
        "author_email": "paul@ganssle.io",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Environment :: Console",
            "Framework :: Sphinx :: Extension",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: Apache Software License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "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 :: Utilities"
        ],
        "description": "=======================\nsphinx_autodoc_variants\n=======================\n\n.. image:: https://travis-ci.org/python-variants/sphinx_autodoc_variants.svg?branch=master\n    :target: https://travis-ci.org/python-variants/sphinx_autodoc_variants\n\nAn extension for sphinx to allow automatic documentation of ``variants`` functions.\n\nOverview\n--------\n\nThe default `sphinx.ext.autodoc <http://www.sphinx-doc.org/en/master/ext/autodoc.html>`_ module does not handle function groups with variants created by the `variants <https://github.com/python-variants/variants>`_ module correctly. This extension registers an automatic documenter that detects variant functions and methods and enables documentation of both the primary and variant functions.\n\nTo use this with your project that uses ``variants``, first install this extension with ``pip`` (or, preferably, add this to the documentation dependencies):\n\n.. code-block::\n\n    pip install sphinx_autodoc_variants\n\nWith this installed, add ``'sphinx_autodoc_variants'`` to the ``extensions`` variable of  your ``conf.py``, e.g.:\n\n.. code-block::\n\n    extensions = ['sphinx.ext.autodoc',\n                  'sphinx.ext.viewcode',\n                  'sphinx_autodoc_variants']\n\n\nThis will enable proper documentation of ``variants`` functions under ``.. automodule`` or other `autodoc directives <http://www.sphinx-doc.org/en/master/ext/autodoc.html>`_.\n\nIf you want to explicitly document a ``variants`` function group, use ``.. autoprimary_function`` for functions and ``.. autoprimary_method`` for methods.\n\n\nLinks\n-----\n\n- Source: https://github.com/python-variants/sphinx_autodoc_variants\n- Bugs: https://github.com/python-variants/sphinx_autodoc_variants/issues\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/python-variants/sphinx_autodoc_variants",
        "keywords": "",
        "license": "Apache 2.0",
        "maintainer": "",
        "maintainer_email": "",
        "name": "sphinx-autodoc-variants",
        "package_url": "https://pypi.org/project/sphinx-autodoc-variants/",
        "platform": "",
        "project_url": "https://pypi.org/project/sphinx-autodoc-variants/",
        "project_urls": {
            "Homepage": "https://github.com/python-variants/sphinx_autodoc_variants"
        },
        "release_url": "https://pypi.org/project/sphinx-autodoc-variants/0.1.0/",
        "requires_dist": null,
        "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
        "summary": "An extension for sphinx to allow automatic documentation of `variants` functions.",
        "version": "0.1.0"
    },
    "last_serial": 3832766,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "46eacb3a68e9f5f228a8e346944f401c",
                    "sha256": "ebe80d21bfd4fffd2474615f987b2774154edd244e1a56ca2e223b61173a02b3"
                },
                "downloads": -1,
                "filename": "sphinx_autodoc_variants-0.1.0-py2.py3-none-any.whl",
                "has_sig": true,
                "md5_digest": "46eacb3a68e9f5f228a8e346944f401c",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
                "size": 4009,
                "upload_time": "2018-05-03T23:24:08",
                "url": "https://files.pythonhosted.org/packages/7e/f9/d2f11964ed49434e4f3971b819fd7cf11ad6a997620cf71328698b775147/sphinx_autodoc_variants-0.1.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "87eeb2e16dfcf57120d7452275451cf8",
                    "sha256": "cc156b4e7dce70cda5b2322dc53a0b37e54292a28e1ffe521e62869e908b089f"
                },
                "downloads": -1,
                "filename": "sphinx_autodoc_variants-0.1.0.tar.gz",
                "has_sig": true,
                "md5_digest": "87eeb2e16dfcf57120d7452275451cf8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
                "size": 4383,
                "upload_time": "2018-05-03T23:24:09",
                "url": "https://files.pythonhosted.org/packages/1b/d2/925bda48553e3e8419b529d9c8dc8598ff2de6c1ae9296a317d43c056441/sphinx_autodoc_variants-0.1.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "46eacb3a68e9f5f228a8e346944f401c",
                "sha256": "ebe80d21bfd4fffd2474615f987b2774154edd244e1a56ca2e223b61173a02b3"
            },
            "downloads": -1,
            "filename": "sphinx_autodoc_variants-0.1.0-py2.py3-none-any.whl",
            "has_sig": true,
            "md5_digest": "46eacb3a68e9f5f228a8e346944f401c",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
            "size": 4009,
            "upload_time": "2018-05-03T23:24:08",
            "url": "https://files.pythonhosted.org/packages/7e/f9/d2f11964ed49434e4f3971b819fd7cf11ad6a997620cf71328698b775147/sphinx_autodoc_variants-0.1.0-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "87eeb2e16dfcf57120d7452275451cf8",
                "sha256": "cc156b4e7dce70cda5b2322dc53a0b37e54292a28e1ffe521e62869e908b089f"
            },
            "downloads": -1,
            "filename": "sphinx_autodoc_variants-0.1.0.tar.gz",
            "has_sig": true,
            "md5_digest": "87eeb2e16dfcf57120d7452275451cf8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
            "size": 4383,
            "upload_time": "2018-05-03T23:24:09",
            "url": "https://files.pythonhosted.org/packages/1b/d2/925bda48553e3e8419b529d9c8dc8598ff2de6c1ae9296a317d43c056441/sphinx_autodoc_variants-0.1.0.tar.gz"
        }
    ]
}