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
|
==============================================
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
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.
|
