{ "info": { "author": "Philipp Sommer", "author_email": "philipp.sommer@unil.ch", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v2 (GPLv2)", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Documentation" ], "description": "==============================================\nExtending your autodoc API docs with a summary\n==============================================\n\n.. start-badges\n\n.. list-table::\n :stub-columns: 1\n :widths: 10 90\n\n * - docs\n - |docs|\n * - tests\n - |travis| |requires| |coveralls|\n * - package\n - |version| |supported-versions| |supported-implementations|\n\n.. |docs| image:: http://readthedocs.org/projects/autodocsumm/badge/?version=latest\n :alt: Documentation Status\n :target: http://autodocsumm.readthedocs.io/en/latest/?badge=latest\n\n.. |travis| image:: https://travis-ci.org/Chilipp/autodocsumm.svg?branch=master\n :alt: Travis\n :target: https://travis-ci.org/Chilipp/autodocsumm\n\n.. |coveralls| image:: https://coveralls.io/repos/github/Chilipp/autodocsumm/badge.svg?branch=master\n :alt: Coverage\n :target: https://coveralls.io/github/Chilipp/autodocsumm?branch=master\n\n.. |requires| image:: https://requires.io/github/Chilipp/autodocsumm/requirements.svg?branch=master\n :alt: Requirements Status\n :target: https://requires.io/github/Chilipp/autodocsumm/requirements/?branch=master\n\n.. |version| image:: https://img.shields.io/pypi/v/autodocsumm.svg?style=flat\n :alt: PyPI Package latest release\n :target: https://pypi.python.org/pypi/autodocsumm\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/autodocsumm.svg?style=flat\n :alt: Supported versions\n :target: https://pypi.python.org/pypi/autodocsumm\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/autodocsumm.svg?style=flat\n :alt: Supported implementations\n :target: https://pypi.python.org/pypi/autodocsumm\n\n\n.. end-badges\n\nWelcome! This sphinx extension provides some useful extensions to the Sphinxs\nautodoc_ extension. Those are\n\n1. It creates a *Table of Contents* in the style of the autosummary_ extension\n with methods, classes, functions and attributes\n2. As you can include the ``__init__`` method documentation for via the\n autoclass_content_ configuration value,\n we provide the *autodata_content* configuration value to include\n the documentation from the ``__call__`` method\n3. You can exclude the string representation of specific objects. E.g. if you\n have a large dictionary using the *not_document_data* configuration\n value.\n\nSee the `Documentation on Readthedocs`_ for more details.\n\n.. _autodoc: http://www.sphinx-doc.org/en/stable/ext/autodoc.html\n.. _autoclass_content: http://www.sphinx-doc.org/en/stable/ext/autodoc.html#confval-autoclass_content\n.. _autosummary: http://www.sphinx-doc.org/en/stable/ext/autosummary.html\n.. _Documentation on Readthedocs: http://autodocsumm.readthedocs.io/en/latest/\n\n\n\nInstallation\n============\nSimply install it via ``pip``::\n\n $ pip install autodocsumm\n\nOr you install it via::\n\n $ python setup.py install\n\nfrom the `source on GitHub`_.\n\n\n.. _source on GitHub: https://github.com/Chilipp/autodocsumm\n\n\nRequirements\n============\nThe package only requires Sphinx_ to be installed. It has been tested for\nversions higher than 1.3.\n\n\n.. _Sphinx: http://www.sphinx-doc.org/en/stable\n\n\nQuickstart\n==========\n\nIn order to activate the autodocsumm extension, you have to list it in your\n``conf.py``:\n\n.. code-block:: python\n\n extensions = [\n 'sphinx.ext.autodoc',\n ...,\n 'autodocsumm',\n ]\n\nOnce this is done, you can use the ``:autosummary:`` option for autodoc\ndirectives to generate a table at the top, e.g.:\n\n.. code-block:: rst\n\n .. automodule:: my.awesome.module\n :autosummary:\n\nOptionally, you can make autodocsumm active by default for all autodoc\ndirectives by adding in ``conf.py``:\n\n.. code-block:: python\n\n autodoc_default_options = {\n 'autosummary': True,\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/Chilipp/autodocsumm", "keywords": "sphinx autodoc autosummary content table", "license": "GPLv2", "maintainer": "", "maintainer_email": "", "name": "autodocsumm", "package_url": "https://pypi.org/project/autodocsumm/", "platform": "", "project_url": "https://pypi.org/project/autodocsumm/", "project_urls": { "Homepage": "https://github.com/Chilipp/autodocsumm" }, "release_url": "https://pypi.org/project/autodocsumm/0.1.11/", "requires_dist": null, "requires_python": "", "summary": "Extended sphinx autodoc including automatic autosummaries", "version": "0.1.11" }, "last_serial": 5862314, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "e61bda215764514f635b554b41e7686a", "sha256": "4090a66b6a1c31399d3a35a6949622642fbfb3619ebcbd667c64049f0344f536" }, "downloads": -1, "filename": "autodocsumm-0.1.0.tar.gz", "has_sig": false, "md5_digest": "e61bda215764514f635b554b41e7686a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9276, "upload_time": "2016-09-03T20:11:51", "url": "https://files.pythonhosted.org/packages/67/8a/1a1303cd06a21a65019ad8c71749fc2e19b363d5af761b61f7c63d3037b7/autodocsumm-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "0de25e64655762454bf713b20caafd7d", "sha256": "31bd5e8d89d21c0de70f1a476416af40fddb6d1c1db7692009e6bf9b52ec48fc" }, "downloads": -1, "filename": "autodocsumm-0.1.1.tar.gz", "has_sig": false, "md5_digest": "0de25e64655762454bf713b20caafd7d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9232, "upload_time": "2016-09-03T20:28:54", "url": "https://files.pythonhosted.org/packages/0a/93/1131c656ff9fe5495958de146fe9c070e0931cffd91de7e051445d2ba7a7/autodocsumm-0.1.1.tar.gz" } ], "0.1.10": [ { "comment_text": "", "digests": { "md5": "03757c7eafde3690eaf505c53a5055d1", "sha256": "0954422a33aed094431a9334e332904eec1d8ef0a18dad051f12a49316128dd0" }, "downloads": -1, "filename": "autodocsumm-0.1.10.tar.gz", "has_sig": false, "md5_digest": "03757c7eafde3690eaf505c53a5055d1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17552, "upload_time": "2019-05-06T11:12:52", "url": "https://files.pythonhosted.org/packages/fd/4f/586a222976cae758a947a7dc2db6e12ff6fb3f63f7d65ebf459c69362feb/autodocsumm-0.1.10.tar.gz" } ], "0.1.11": [ { "comment_text": "", "digests": { "md5": "5212b08eb20632c1cd21830718fcaada", "sha256": "d4ba2fe3a07d2e13165509c3e275f0e16b11e84c873adccaa1e31502a59c452a" }, "downloads": -1, "filename": "autodocsumm-0.1.11.tar.gz", "has_sig": false, "md5_digest": "5212b08eb20632c1cd21830718fcaada", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18006, "upload_time": "2019-09-20T13:29:18", "url": "https://files.pythonhosted.org/packages/7c/2d/d8eb07ca710aa602e97939dcae40463585c61e57fc2f0b128abbdf639de1/autodocsumm-0.1.11.tar.gz" } ], "0.1.2": [], "0.1.3": [ { "comment_text": "", "digests": { "md5": "c0cae3b003275728e9eb5f6e902bdbfa", "sha256": "bb5cbfb62707976bbdec5c08d48c8abd38b7cd08d4581111580aa0cb02d55bf6" }, "downloads": -1, "filename": "autodocsumm-0.1.3.tar.gz", "has_sig": false, "md5_digest": "c0cae3b003275728e9eb5f6e902bdbfa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9311, "upload_time": "2016-11-14T16:48:31", "url": "https://files.pythonhosted.org/packages/26/bb/9bdbb1a69ccbec1f1a6544cfddef02f006ea5e83845cfaa586610742818d/autodocsumm-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "02aa97e3e154b00cacb966da2f347c4d", "sha256": "d9f41cc59159a958b6685314e44cffba5d0c2c4f1cc666f916334f6158b24dbc" }, "downloads": -1, "filename": "autodocsumm-0.1.4.tar.gz", "has_sig": false, "md5_digest": "02aa97e3e154b00cacb966da2f347c4d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16140, "upload_time": "2017-03-11T13:24:08", "url": "https://files.pythonhosted.org/packages/ee/e2/5da29530eaae98f7125c0f91f13dfce14258e3dcf796472c2e938c0a92f7/autodocsumm-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "c5253e5a43170c77d6b779b4d4ff6e6b", "sha256": "880f2e9f25bc1c9a8a903fdea917e5e3e62303b34bc4c6ea5620a563da234c30" }, "downloads": -1, "filename": "autodocsumm-0.1.5.tar.gz", "has_sig": false, "md5_digest": "c5253e5a43170c77d6b779b4d4ff6e6b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15365, "upload_time": "2017-08-14T10:03:40", "url": "https://files.pythonhosted.org/packages/2e/21/d6a252d43231d6182248252874064255ca245fec7bdfdb0af7efff600cda/autodocsumm-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "41ce2dc732b01b1b20c78ab9bcf0b766", "sha256": "baeeb983ae5676005b72965299a7768c73c38b31804a4852e280f10ce7c65fee" }, "downloads": -1, "filename": "autodocsumm-0.1.6.tar.gz", "has_sig": false, "md5_digest": "41ce2dc732b01b1b20c78ab9bcf0b766", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16797, "upload_time": "2018-02-14T19:31:09", "url": "https://files.pythonhosted.org/packages/48/f4/9ef608570540e5a9f6e73e0e1be6f73394f44c7b7f22d1ebc87b45135765/autodocsumm-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "3491fb344abd1144eccfea4465865f7a", "sha256": "0886623bf35a4344a3590c1236277512620708d28b031028c2159bc97450ae36" }, "downloads": -1, "filename": "autodocsumm-0.1.7.tar.gz", "has_sig": false, "md5_digest": "3491fb344abd1144eccfea4465865f7a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16812, "upload_time": "2018-09-20T13:29:50", "url": "https://files.pythonhosted.org/packages/0c/ba/aea363f8a36c10f52ba12a9fdb0e6bae73427fdf38e91c0315d4b59f0eab/autodocsumm-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "6f34b5808c52d6c4739c8566347db080", "sha256": "eebfd0a95ee0f0b7aad983406b605ec4b4b96b28b2288c4228645f758aeb967b" }, "downloads": -1, "filename": "autodocsumm-0.1.8.tar.gz", "has_sig": false, "md5_digest": "6f34b5808c52d6c4739c8566347db080", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16895, "upload_time": "2019-04-03T07:14:56", "url": "https://files.pythonhosted.org/packages/66/22/36b5afaa312fa90cb50dc23f83268b2f6fd258742fafb6503e098dd17233/autodocsumm-0.1.8.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "a0d87b43498ae4859c838748607f4c1c", "sha256": "97ec6cdf83ba733e625e681c0d1c9cf370912985814e5bc13c6af7c6ad055c1b" }, "downloads": -1, "filename": "autodocsumm-0.1.9.tar.gz", "has_sig": false, "md5_digest": "a0d87b43498ae4859c838748607f4c1c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17526, "upload_time": "2019-04-05T08:35:25", "url": "https://files.pythonhosted.org/packages/4d/b8/13b92aae32738f1d7c0c93b4972ecae30e7d18b8b4208ed9d9a20e9693b2/autodocsumm-0.1.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5212b08eb20632c1cd21830718fcaada", "sha256": "d4ba2fe3a07d2e13165509c3e275f0e16b11e84c873adccaa1e31502a59c452a" }, "downloads": -1, "filename": "autodocsumm-0.1.11.tar.gz", "has_sig": false, "md5_digest": "5212b08eb20632c1cd21830718fcaada", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18006, "upload_time": "2019-09-20T13:29:18", "url": "https://files.pythonhosted.org/packages/7c/2d/d8eb07ca710aa602e97939dcae40463585c61e57fc2f0b128abbdf639de1/autodocsumm-0.1.11.tar.gz" } ] }