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

Skip to content

Commit f9a96fe

Browse files
committed
Add numpydoc to the list of extensions.
1 parent 8ea6241 commit f9a96fe

5 files changed

Lines changed: 939 additions & 4 deletions

File tree

doc/conf.py

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,14 @@
1111
# All configuration values have a default value; values that are commented out
1212
# serve to show the default value.
1313

14-
import sys, os
14+
import os
15+
import sys
16+
import sphinx
1517

1618
# If your extensions are in another directory, add it here. If the directory
1719
# is relative to the documentation root, use os.path.abspath to make it
1820
# absolute, like shown here.
19-
sys.path.append(os.path.abspath('sphinxext'))
21+
sys.path.insert(0, os.path.abspath('sphinxext'))
2022

2123
# General configuration
2224
# ---------------------
@@ -28,7 +30,14 @@
2830
'sphinx.ext.doctest',
2931
'matplotlib.sphinxext.plot_directive', 'sphinx.ext.inheritance_diagram',
3032
'gen_gallery', 'gen_rst',
31-
'matplotlib.sphinxext.ipython_console_highlighting', 'github']
33+
'matplotlib.sphinxext.ipython_console_highlighting', 'github',
34+
'numpy_ext.numpydoc']
35+
36+
37+
autosummary_generate = True
38+
39+
if sphinx.__version__ >= 1.1:
40+
autodoc_docstring_signature = True
3241

3342
# Add any paths that contain templates here, relative to this directory.
3443
templates_path = ['_templates']
@@ -133,7 +142,9 @@
133142

134143
# Additional templates that should be rendered to pages, maps page names to
135144
# template names.
136-
html_additional_pages = {'index': 'index.html', 'gallery':'gallery.html', 'citing':'citing.html'}
145+
html_additional_pages = {'index': 'index.html',
146+
'gallery':'gallery.html',
147+
'citing': 'citing.html'}
137148

138149
# If false, no module index is generated.
139150
#html_use_modindex = True

doc/sphinxext/numpy_ext/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)