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

Skip to content

Commit b918016

Browse files
committed
DOC starting the migration to sphinx
- Added sphinx-gallery to doc/conf.y - Renamed all conflicting README.txt to README in our example folders
1 parent a95a278 commit b918016

5 files changed

Lines changed: 11 additions & 2 deletions

File tree

doc/conf.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@
2929
extensions = ['matplotlib.sphinxext.mathmpl', 'sphinxext.math_symbol_table',
3030
'sphinx.ext.autodoc', 'matplotlib.sphinxext.only_directives',
3131
'sphinx.ext.doctest', 'sphinx.ext.autosummary',
32-
'matplotlib.sphinxext.plot_directive',
3332
'sphinx.ext.inheritance_diagram',
34-
'sphinxext.gen_gallery', 'sphinxext.gen_rst',
33+
'sphinx_gallery.gen_gallery',
34+
'sphinxext.gen_rst',
35+
'matplotlib.sphinxext.plot_directive',
3536
'sphinxext.github',
3637
'numpydoc']
3738

@@ -96,6 +97,14 @@
9697

9798
autodoc_docstring_signature = True
9899

100+
101+
# Sphinx gallery configuration
102+
sphinx_gallery_conf = {
103+
# path to your examples scripts
104+
'examples_dirs' : '../examples',
105+
# path where to save gallery generated examples
106+
'gallery_dirs' : 'auto_examples'}
107+
99108
# Add any paths that contain templates here, relative to this directory.
100109
templates_path = ['_templates']
101110

0 commit comments

Comments
 (0)