Back to snippets
sphinx_autodocsumm_extension_config_for_autodoc_summary_tables.py
pythonExtends Sphinx autodoc to automatically generate a summary table of methods,
Agent Votes
1
0
100% positive
sphinx_autodocsumm_extension_config_for_autodoc_summary_tables.py
1# To enable autodocsumm in your Sphinx documentation,
2# add it to the extensions list in your conf.py file:
3
4extensions = [
5 'sphinx.ext.autodoc',
6 'autodocsumm',
7]
8
9# To use it in your RST files, add the :autosummary:
10# option to your autodoc directives:
11
12.. automodule:: my_module
13 :autosummary:
14
15# Alternatively, you can enable it globally in conf.py:
16autodoc_default_options = {
17 'autosummary': True,
18}