Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit c88ea90

Browse files
committed
Simplify required configuration
1 parent 6b61a36 commit c88ea90

File tree

3 files changed

+5
-8
lines changed

3 files changed

+5
-8
lines changed

docs/conf.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
# Add any Sphinx extension module names here, as strings. They can be
77
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
88
# ones.
9-
extensions = ['sphinx.ext.autosummary',
10-
'sphinx_automodapi.automodsumm',
11-
'sphinx_automodapi.automodapi']
9+
extensions = ['sphinx_automodapi.automodapi']
1210

1311
# Add any paths that contain templates here, relative to this directory.
1412
templates_path = ['_templates']

docs/index.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,10 @@ possible to do::
2424
Quick start
2525
-----------
2626

27-
To use this extension, you will need to add the following entries to the
27+
To use this extension, you will need to add the following entry to the
2828
``extensions`` list in your Sphinx ``conf.py`` file::
2929

30-
extensions = ['sphinx.ext.autosummary',
31-
'sphinx_automodapi.automodsumm',
32-
'sphinx_automodapi.automodapi']
30+
extensions = ['sphinx_automodapi.automodapi']
3331

3432
.. TODO: we could make automodsumm be automatically set up when automodapi is set up
3533

sphinx_automodapi/automodapi.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,8 @@ def process_automodapi(app, docname, source):
370370

371371

372372
def setup(app):
373-
# need automodsumm for automodapi
373+
374+
app.setup_extension('sphinx.ext.autosummary')
374375
app.setup_extension('sphinx_automodapi.automodsumm')
375376

376377
app.connect('source-read', process_automodapi)

0 commit comments

Comments
 (0)