{
    "info": {
        "author": "rdb",
        "author_email": "me@rdb.name",
        "bugtrack_url": null,
        "classifiers": [
            "Framework :: Sphinx",
            "License :: Public Domain",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3",
            "Topic :: Documentation",
            "Topic :: Software Development :: Documentation"
        ],
        "description": "sphinx-autopackagesummary\n=========================\n\nThis is a [Sphinx](https://www.sphinx-doc.org/) extension that makes it\npossible to automatically generate API documentation for deeply nested Python\npackages using the built-in autosummary extension.\n\nThe problem with the built-in autosummary directive is that it does not\nautomatically pick up nested sub-modules, requiring tedious manual work to\nspecify the entire module tree.\n\nInstead of this:\n\n```rst\n.. autosummary::\n   :toctree: _autosummary\n\n   mypackage.submodule1\n   mypackage.submodule2\n   mypackage.submodule3\n```\n\nYou can now simply use this:\n\n```rst\n.. autopackagesummary:: mypackage\n   :toctree: _autosummary\n```\n\nUsage\n-----\n\nTo make use of this extension, the following steps are needed:\n\n1. Install the module using pip.\n```\npip install sphinx-autopackagesummary\n```\n2. Enable it in `conf.py`.\n```python\nextensions = ['sphinx.ext.autosummary', 'sphinx_autopackagesummary']\n\nautosummary_generate = True\n```\n3. Make use of the new syntax\n\nConfiguration\n-------------\n\nThe `autopackagesummary` directive accepts all options that are supported by\n`autosummary`, which are simply passed on.\n\nTo exclude packages from being imported, add them to the config setting\n`autosummary_mock_imports`.\n\nRecursive generation\n--------------------\n\nIf your packages have subpackages, it is possible to use this recursively by\ncustomizing the autosummary template.  For example, you could have your root\npackage documented like so:\n```rst\n.. py:package:: mypackage\n\n   This is my package.\n\n   .. autopackagesummary:: mypackage\n      :toctree: _autosummary\n      :template: autosummary/package.rst\n```\n\nAnd then create a `_templates/autosummary/package.rst` like so:\n\n```rst\n{{ fullname | escape | underline }}\n\n.. automodule:: {{ fullname }}\n\n   .. autopackagesummary:: {{ fullname }}\n      :toctree: .\n      :template: autosummary/package.rst\n```\n\nAlternatively, you can override the default `module.rst` template.\n\nNote the use of `.` for the toctree setting: otherwise, the `_autosummary`\ndirectories would keep nesting, like `_autosummary/_autosummary/module.rst`.\n\nLicense\n-------\n\nThis extension has been placed into the public domain.  If you make a\ncontribution to this repository, you are placing your modifications into the\npublic domain as well.\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/rdb/sphinx-autopackagesummary",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "sphinx-autopackagesummary",
        "package_url": "https://pypi.org/project/sphinx-autopackagesummary/",
        "platform": "",
        "project_url": "https://pypi.org/project/sphinx-autopackagesummary/",
        "project_urls": {
            "Homepage": "https://github.com/rdb/sphinx-autopackagesummary"
        },
        "release_url": "https://pypi.org/project/sphinx-autopackagesummary/1.3/",
        "requires_dist": [
            "sphinx"
        ],
        "requires_python": ">= 3.4",
        "summary": "Sphinx extension to automatically generate autosummary tables for Python packages",
        "version": "1.3",
        "yanked": false,
        "yanked_reason": null
    },
    "last_serial": 7210175,
    "releases": {
        "1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c11661f752bb6a79e4b1d0a1c20a8172",
                    "sha256": "0a7275de4e05302ef5e35af5fd3ec1b536796b2f1aef284ca07ebd556eac849a"
                },
                "downloads": -1,
                "filename": "sphinx_autopackagesummary-1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c11661f752bb6a79e4b1d0a1c20a8172",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 3577,
                "upload_time": "2019-10-27T17:45:40",
                "upload_time_iso_8601": "2019-10-27T17:45:40.435197Z",
                "url": "https://files.pythonhosted.org/packages/31/d5/96b408725a210ab83deb66ed830667f0c89932498fea6ae4e6ea2238b34b/sphinx_autopackagesummary-1.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f40c1d29ff0089882d31470fd26b1527",
                    "sha256": "aee0e97d92678591317fed4303128d347574776d8f42a3b42d242cdee60ba952"
                },
                "downloads": -1,
                "filename": "sphinx_autopackagesummary-1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f40c1d29ff0089882d31470fd26b1527",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 3626,
                "upload_time": "2019-10-27T20:27:52",
                "upload_time_iso_8601": "2019-10-27T20:27:52.373030Z",
                "url": "https://files.pythonhosted.org/packages/c4/4c/c34faf7b4190fed81e7803c7199d3ceedf12bab9568b90c529ac54c74ed9/sphinx_autopackagesummary-1.1-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d62dc27a1157b2de6dd2978ca94cee2b",
                    "sha256": "094c53366e2bedfeb56f3e59ea8af42e403b954d005f3abd96e759fc03855d6b"
                },
                "downloads": -1,
                "filename": "sphinx_autopackagesummary-1.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d62dc27a1157b2de6dd2978ca94cee2b",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 3842,
                "upload_time": "2019-11-21T11:16:59",
                "upload_time_iso_8601": "2019-11-21T11:16:59.147122Z",
                "url": "https://files.pythonhosted.org/packages/e6/8e/888c47e6b015f1aac5a6768a219512bbaba42f7b4224c2850dec65e515cc/sphinx_autopackagesummary-1.2-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "62d7ac66f04bad011b6971b510bb2973",
                    "sha256": "cfa1462d1301afecd0724bbe42b26de811c2717d000e9fbe1b73e16932fddb8c"
                },
                "downloads": -1,
                "filename": "sphinx_autopackagesummary-1.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "62d7ac66f04bad011b6971b510bb2973",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">= 3.4",
                "size": 3792,
                "upload_time": "2020-05-10T19:31:40",
                "upload_time_iso_8601": "2020-05-10T19:31:40.281729Z",
                "url": "https://files.pythonhosted.org/packages/12/b9/8597c79390de7f7e99c46b89a1344b1bc8a3d09d002621ec29793c35d5b3/sphinx_autopackagesummary-1.3-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "62d7ac66f04bad011b6971b510bb2973",
                "sha256": "cfa1462d1301afecd0724bbe42b26de811c2717d000e9fbe1b73e16932fddb8c"
            },
            "downloads": -1,
            "filename": "sphinx_autopackagesummary-1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "62d7ac66f04bad011b6971b510bb2973",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">= 3.4",
            "size": 3792,
            "upload_time": "2020-05-10T19:31:40",
            "upload_time_iso_8601": "2020-05-10T19:31:40.281729Z",
            "url": "https://files.pythonhosted.org/packages/12/b9/8597c79390de7f7e99c46b89a1344b1bc8a3d09d002621ec29793c35d5b3/sphinx_autopackagesummary-1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "vulnerabilities": []
}