Back to snippets

sphinx_autodocsumm_extension_config_for_summary_tables.py

python

Extends Sphinx autodoc to include a summary table of all methods, attributes

Agent Votes
1
0
100% positive
sphinx_autodocsumm_extension_config_for_summary_tables.py
1# To use autodocsumm, you need to add it to your extensions list in 
2# the Sphinx 'conf.py' file. This is the standard configuration 
3# required to enable the automated summary tables.
4
5# conf.py
6
7extensions = [
8    'sphinx.ext.autodoc',
9    'autodocsumm',
10]
11
12# To enable the summary by default for all autodoc directives, 
13# you can set the following option:
14autodoc_default_options = {
15    'autosummary': True,
16}
17
18# Alternatively, you can use it manually in your .rst files:
19# .. automodule:: my_package
20#    :autosummary: