https://github.com/chilipp/autodocsumm

Extending your autodoc API docs with a summary

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
○
.zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary

Keywords from Contributors

sphinx

Last synced: 11 months ago · JSON representation

Repository

Extending your autodoc API docs with a summary

Basic Info

Host: GitHub
Owner: Chilipp
License: apache-2.0
Language: Python
Default Branch: master
Size: 271 KB

Statistics

Stars: 50
Watchers: 3
Forks: 14
Open Issues: 10
Releases: 24

Created almost 10 years ago · Last pushed over 1 year ago

Metadata Files

Readme License

README.rst

==============================================
Extending your autodoc API docs with a summary
==============================================

.. start-badges

.. list-table::
    :stub-columns: 1
    :widths: 10 90

    * - docs
      - |docs|
    * - tests
      - |github-action| |codecov|
    * - package
      - |version| |supported-versions| |supported-implementations|

.. |docs| image:: http://readthedocs.org/projects/autodocsumm/badge/?version=latest
    :alt: Documentation Status
    :target: http://autodocsumm.readthedocs.io/en/latest/?badge=latest

.. |github-action| image:: https://github.com/Chilipp/autodocsumm/workflows/Tests/badge.svg
    :alt: Tests
    :target: https://github.com/Chilipp/autodocsumm/actions?query=workflow%3A%22Tests%22

.. |codecov| image:: https://codecov.io/gh/Chilipp/autodocsumm/branch/master/graph/badge.svg?token=I9wlZyhI4Y
    :alt: Codecov
    :target: https://codecov.io/gh/Chilipp/autodocsumm

.. |version| image:: https://img.shields.io/pypi/v/autodocsumm.svg?style=flat
    :alt: PyPI Package latest release
    :target: https://pypi.python.org/pypi/autodocsumm

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/autodocsumm.svg?style=flat
    :alt: Supported versions
    :target: https://pypi.python.org/pypi/autodocsumm

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/autodocsumm.svg?style=flat
    :alt: Supported implementations
    :target: https://pypi.python.org/pypi/autodocsumm


.. end-badges

Welcome! This sphinx extension provides some useful extensions to the Sphinxs
autodoc_ extension. Those are

1. It creates a *Table of Contents* in the style of the autosummary_ extension
   with methods, classes, functions and attributes
2. As you can include the ``__init__`` method documentation for via the
   autoclass_content_ configuration value,
   we provide the *autodata_content* configuration value to include
   the documentation from the ``__call__`` method
3. You can exclude the string representation of specific objects. E.g. if you
   have a large dictionary using the *not_document_data* configuration
   value.

See the `Documentation on Readthedocs`_ for more details.

.. _autodoc: http://www.sphinx-doc.org/en/stable/ext/autodoc.html
.. _autoclass_content: http://www.sphinx-doc.org/en/stable/ext/autodoc.html#confval-autoclass_content
.. _autosummary: http://www.sphinx-doc.org/en/stable/ext/autosummary.html
.. _Documentation on Readthedocs: http://autodocsumm.readthedocs.io/en/latest/



Installation
============
Simply install it via ``pip``::

    $ pip install autodocsumm


Local development
^^^^^^^^^^^^^^^^^

Use ``pip`` on the `source on GitHub`_::

    $ pip install .


.. _source on GitHub: https://github.com/Chilipp/autodocsumm


Requirements
============
The package only requires Sphinx_ to be installed. It has been tested for
versions higher than 1.3.


.. _Sphinx: http://www.sphinx-doc.org/en/master


Quickstart
==========

In order to activate the autodocsumm extension, you have to list it in your
``conf.py``:

.. code-block:: python

    extensions = [
        'sphinx.ext.autodoc',
        ...,
        'autodocsumm',
    ]

Once this is done, you can use the ``:autosummary:`` option for autodoc
directives to generate a table at the top, e.g.:

.. code-block:: rst

    .. automodule:: my.awesome.module
        :autosummary:

Optionally, you can make autodocsumm active by default for all autodoc
directives by adding in ``conf.py``:

.. code-block:: python

    autodoc_default_options = {
        'autosummary': True,
    }


Disclaimer
==========
Copyright 2016-2019, Philipp S. Sommer

Copyright 2020-2021, Helmholtz-Zentrum Hereon

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Owner

Name: Philipp S. Sommer
Login: Chilipp
Kind: user
Location: Geesthacht, Germany
Company: Helmholtz-Zentrum hereon

Website: philipp-s-sommer.de
Repositories: 77
Profile: https://github.com/Chilipp

GitHub Events

Total

Create event: 3
Release event: 1
Issues event: 5
Watch event: 5
Delete event: 1
Issue comment event: 8
Push event: 7
Pull request review event: 1
Pull request review comment event: 1
Pull request event: 7

Last Year

Create event: 3
Release event: 1
Issues event: 5
Watch event: 5
Delete event: 1
Issue comment event: 8
Push event: 7
Pull request review event: 1
Pull request review comment event: 1
Pull request event: 7

Committers

Last synced: about 1 year ago

All Time

Total Commits: 208
Total Committers: 13
Avg Commits per committer: 16.0
Development Distribution Score (DDS): 0.188

Past Year

Commits: 15
Committers: 2
Avg Commits per committer: 7.5
Development Distribution Score (DDS): 0.467

Top Committers

Name	Email	Commits
Philipp S. Sommer	p**r@h**e	169
theOehrly	2****y	10
Frank Sachsenheim	f**e@r**t	7
Jérôme Lafréchoux	j**e@j**r	4
Laurie O	l**n@h**m	3
Piyush Khandelwal	p**k@c**m	3
Thomas Gläßle	t**e@g**e	3
Chilipp	p**r@u**h	3
Daniel Burkhardt	b**b@g**m	2
Derrick Gilland	d**d@g**m	1
Dominic Davis-Foster	d**c@d**k	1
Myoungdo Park	c**d@g**m	1
Justin Poehnelt	j**n@d**m	1

Committer Domains (Top 20 + Academic)

descarteslabs.com: 1 davis-foster.co.uk: 1 unil.ch: 1 gmx.de: 1 cogitai.com: 1 jolimont.fr: 1 riseup.net: 1 hzg.de: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time

Total issues: 54
Total pull requests: 53
Average time to close issues: 3 months
Average time to close pull requests: 11 days
Total issue authors: 35
Total pull request authors: 14
Average comments per issue: 2.35
Average comments per pull request: 2.7
Merged pull requests: 50
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 5
Pull requests: 7
Average time to close issues: 3 days
Average time to close pull requests: about 1 month
Issue authors: 4
Pull request authors: 3
Average comments per issue: 1.4
Average comments per pull request: 1.57
Merged pull requests: 6
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

kloczek (6)
maeddlae (5)
andy-maier (5)
Chilipp (3)
raymanP (3)
scottgigante (2)
coldfix (2)
greyli (1)
piyushk (1)
funkyfuture (1)
jbloom (1)
jenshnielsen (1)
vepain (1)
leroyvn (1)
lafrech (1)

Pull Request Authors

Chilipp (32)
theOehrly (9)
EpicWink (3)
Aman-Clement (2)
jpoehnelt (2)
lafrech (2)
funkyfuture (2)
coldfix (2)
domdfcoding (1)
MeggyCal (1)
cuspymd (1)
dburkhardt (1)
piyushk (1)
dgilland (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 3
Total downloads:
- pypi 392,221 last-month
Total docker downloads: 683

Total dependent packages: 151
(may contain duplicates)
Total dependent repositories: 752
(may contain duplicates)
Total versions: 49
Total maintainers: 2

pypi.org: autodocsumm

Extended sphinx autodoc including automatic autosummaries

Homepage: https://github.com/Chilipp/autodocsumm
Documentation: https://autodocsumm.readthedocs.io/en/latest/
License: Apache-2.0
Latest release: 0.2.14
published over 1 year ago

Versions: 29
Dependent Packages: 149
Dependent Repositories: 740
Downloads: 392,221 Last month
Docker Downloads: 683

Rankings

Dependent packages count: 0.1%

Dependent repos count: 0.4%

Average: 0.9%

Downloads: 1.0%

Docker downloads count: 2.0%

Maintainers (1)

Chilipp

Last synced: 11 months ago

spack.io: py-autodocsumm

Extended sphinx autodoc including automatic autosummaries.

Homepage: https://github.com/Chilipp/autodocsumm
License: []
Latest release: 0.2.11
published over 2 years ago

Versions: 1
Dependent Packages: 1
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Stargazers count: 22.4%

Forks count: 24.0%

Average: 26.2%

Dependent packages count: 58.4%

Maintainers (1)

LydDeb

Last synced: 11 months ago

This sphinx extension provides some useful extensions to the Sphinxs autodoc_ extension. Those include automatic and grouped summary tables for modules and classes, as well as documenting the __call__ method

Homepage: https://github.com/Chilipp/autodocsumm
License: Apache-2.0
Latest release: 0.2.9
published almost 4 years ago

Versions: 19
Dependent Packages: 1
Dependent Repositories: 12

Rankings

Dependent repos count: 10.2%

Dependent packages count: 29.0%

Average: 30.7%

Stargazers count: 41.0%

Forks count: 42.7%

Last synced: 11 months ago

Dependencies

.github/workflows/python-app.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite

docs/requirements.txt pypi

Sphinx <7

pyproject.toml pypi

Sphinx >= 2.2, < 8.0

setup.py pypi

https://github.com/chilipp/autodocsumm

Science Score: 13.0%

Keywords from Contributors

Repository

Basic Info

Statistics

Metadata Files

README.rst

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: autodocsumm

Rankings

Maintainers (1)

spack.io: py-autodocsumm

Rankings

Maintainers (1)

conda-forge.org: autodocsumm

Rankings

Dependencies