1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
.. autodocsumm documentation master file, created by
sphinx-quickstart on Mon Jul 20 18:01:33 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
==============================================
Extending your autodoc API docs with a summary
==============================================
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
:confval:`autoclass_content <sphinx:autoclass_content>` configuration value,
we provide the :confval:`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 :confval:`not_document_data` configuration
value.
See the :ref:`examples` section for more details.
.. _autodoc: http://www.sphinx-doc.org/en/stable/ext/autodoc.html
.. _autosummary: http://www.sphinx-doc.org/en/stable/ext/autosummary.html
Content
-------
.. toctree::
:maxdepth: 1
conf_settings
examples
api/autodocsumm.rst
Installation
============
Simply install it via ``pip``::
$ pip install autodocsumm
Or you install it via::
$ python setup.py install
from the `source on GitHub`_.
.. _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/stable
Quickstart
==========
In order to activate the autodocsumm extension, you have to list it in your
``conf.py``:
.. code-block:: python
:caption: conf.py
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:: autodocsumm
:autosummary:
Optionally, you can make autodocsumm active by default for all autodoc
directives by adding:
.. code-block:: python
:caption: conf.py
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.
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
