diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2012-03-11 12:42:54 +0000 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-03-11 12:42:54 +0000 |
| commit | e006d45c7b0cad047c86456cb21c5520f6001f74 (patch) | |
| tree | 40ac0e4f3627900e77dae16868096c30c1bd7cc4 /docs/source/conf.py | |
| parent | 57242300d75e0ac0a908be92ed3994c73cf63132 (diff) | |
doc: autodoc classes' constructors docstring
Diffstat (limited to 'docs/source/conf.py')
| -rw-r--r-- | docs/source/conf.py | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index ca8f8fb2..a31c1028 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -49,6 +49,12 @@ from alot import __version__,__author__ # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] +# autodoc tweaks + +# show classes' docstrings _and_ constructors docstrings/parameters +autoclass_content = 'both' + + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] |