{"id":16200046,"url":"https://github.com/chilipp/autodocsumm","last_synced_at":"2025-04-09T18:21:41.038Z","repository":{"id":10870074,"uuid":"67231532","full_name":"Chilipp/autodocsumm","owner":"Chilipp","description":"Extending your autodoc API docs with a summary","archived":false,"fork":false,"pushed_at":"2024-01-05T09:17:09.000Z","size":232,"stargazers_count":48,"open_issues_count":11,"forks_count":13,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-06-11T16:54:01.585Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Chilipp.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-09-02T14:56:18.000Z","updated_at":"2024-06-12T18:05:29.922Z","dependencies_parsed_at":"2024-06-12T18:05:29.583Z","dependency_job_id":"a7ecb3aa-1236-49e4-992f-b19d3abde654","html_url":"https://github.com/Chilipp/autodocsumm","commit_stats":{"total_commits":193,"total_committers":16,"mean_commits":12.0625,"dds":0.616580310880829,"last_synced_commit":"6834615ae9b5730eec058f642007bac0aef2dfcf"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chilipp%2Fautodocsumm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chilipp%2Fautodocsumm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chilipp%2Fautodocsumm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chilipp%2Fautodocsumm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Chilipp","download_url":"https://codeload.github.com/Chilipp/autodocsumm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248085596,"owners_count":21045184,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T09:29:06.902Z","updated_at":"2025-04-09T18:21:41.004Z","avatar_url":"https://github.com/Chilipp.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"==============================================\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      - |github-action| |codecov|\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.. |github-action| image:: https://github.com/Chilipp/autodocsumm/workflows/Tests/badge.svg\n    :alt: Tests\n    :target: https://github.com/Chilipp/autodocsumm/actions?query=workflow%3A%22Tests%22\n\n.. |codecov| image:: https://codecov.io/gh/Chilipp/autodocsumm/branch/master/graph/badge.svg?token=I9wlZyhI4Y\n    :alt: Codecov\n    :target: https://codecov.io/gh/Chilipp/autodocsumm\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\n\nLocal development\n^^^^^^^^^^^^^^^^^\n\nUse ``pip`` on the `source on GitHub`_::\n\n    $ pip install .\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/master\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    }\n\n\nDisclaimer\n==========\nCopyright 2016-2019, Philipp S. Sommer\n\nCopyright 2020-2021, Helmholtz-Zentrum Hereon\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchilipp%2Fautodocsumm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchilipp%2Fautodocsumm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchilipp%2Fautodocsumm/lists"}