summaryrefslogtreecommitdiff
path: root/docs/source/conf.py
diff options
context:
space:
mode:
authorAlexandre Gramfort <alexandre.gramfort@m4x.org>2016-12-02 12:49:38 +0100
committerAlexandre Gramfort <alexandre.gramfort@m4x.org>2016-12-02 12:57:25 +0100
commitf439f777084690ecbf54bcd8d67dadc883fffa31 (patch)
tree56c8a160fb6edcdaca8ca6ce6de1949b9bc33b77 /docs/source/conf.py
parent8dbfd3edae649f5f3e87be4a3ce446c59729b2f7 (diff)
first attempt to support sphinx-gallery
Diffstat (limited to 'docs/source/conf.py')
-rw-r--r--docs/source/conf.py30
1 files changed, 21 insertions, 9 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py
index f48a868..61505cc 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -15,23 +15,25 @@
import sys
import os
import re
+import sphinx_gallery
+
#try:
-from unittest.mock import MagicMock
+# from unittest.mock import MagicMock
#except ImportError:
# from mock import MagicMock
-sys.path.insert(0, os.path.abspath("../.."))
+# sys.path.insert(0, os.path.abspath("../.."))
#sys.setrecursionlimit(1500)
-class Mock(MagicMock):
- @classmethod
- def __getattr__(cls, name):
- return Mock()
+# class Mock(MagicMock):
+# @classmethod
+# def __getattr__(cls, name):
+# return Mock()
-MOCK_MODULES = [ 'emd','ot.lp.emd']
-sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+# MOCK_MODULES = [ 'emd','ot.lp.emd']
+# sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@@ -54,7 +56,9 @@ extensions = [
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
- 'sphinx.ext.viewcode', 'sphinx.ext.napoleon'
+ 'sphinx.ext.viewcode',
+ 'sphinx.ext.napoleon',
+ 'sphinx_gallery.gen_gallery',
]
# Add any paths that contain templates here, relative to this directory.
@@ -316,3 +320,11 @@ texinfo_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
+
+sphinx_gallery_conf = {
+ 'examples_dirs': '../../examples',
+ 'gallery_dirs': 'auto_examples',
+ 'reference_url': {
+ 'numpy': 'http://docs.scipy.org/doc/numpy-1.9.1',
+ 'scipy': 'http://docs.scipy.org/doc/scipy-0.17.0/reference'}
+}