Skip to content

Commit 01d4655

Browse files
committed
Add plots to API documentation
1 parent 12b0aba commit 01d4655

File tree

4 files changed

+997
-7
lines changed

4 files changed

+997
-7
lines changed

doc/conf.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
# add these directories to sys.path here. If the directory is relative to the
2222
# documentation root, use os.path.abspath to make it absolute, like shown here.
2323
sys.path.insert(0, os.path.abspath('..'))
24+
sys.path.insert(0, os.path.abspath('.')) # temporary, for plot_directive
2425

2526
# -- General configuration ------------------------------------------------
2627

@@ -37,6 +38,9 @@
3738
# support for NumPy-style docstrings:
3839
'sphinxcontrib.napoleon', # Will be 'sphinx.ext.napoleon' in Sphinx >= 1.3
3940
'sphinx.ext.intersphinx',
41+
'plot_directive', # temporary, for :context:close-figs feature
42+
# When matplotlib > 1.4.3 is available on readthedocs, we can use this:
43+
#'matplotlib.sphinxext.plot_directive',
4044
]
4145

4246
autoclass_content = "init"
@@ -60,6 +64,11 @@
6064
'matplotlib': ('http://matplotlib.sourceforge.net/', None),
6165
}
6266

67+
plot_include_source = True
68+
plot_html_show_source_link = False
69+
plot_html_show_formats = False
70+
plot_pre_code = ""
71+
6372
# Add any paths that contain templates here, relative to this directory.
6473
templates_path = ['_templates']
6574

0 commit comments

Comments
 (0)