[MRG+1] [DOC, ENH] Add binder links to documentation (nilearn#2300)

emdupre · web-flow · commit 838930ef4aec · 2020-02-05T17:25:05.000+01:00
* infra: inital commit of binder infra

* enh: update conf.py for Binder configuration

* enh: build from master branch for Binder config

* tmp: use emdupre built documentation for binder infra

* infra: update binder dependencies

* fix: update to nilearn.github.io

* sty: update CSS for sphx-glr-download-link-note

* sty: updates download note to match sphinx admonition styling

* doc: update whats_new
diff --git a/doc/binder/requirements.txt b/doc/binder/requirements.txt
@@ -0,0 +1,2 @@
+-r ./requirements-build-docs.txt
+nilearn>=0.6.1
diff --git a/doc/conf.py b/doc/conf.py
@@ -302,14 +302,26 @@
     'backreferences_dir': os.path.join('modules', 'generated'),
     'reference_url': {'nilearn': None},
     'junit': '../test-results/sphinx-gallery/junit.xml',
+    'examples_dirs': '../examples',
+    'gallery_dirs': 'auto_examples',
+    'binder': {
+        'org': 'nilearn',
+        'repo': 'nilearn.github.io',
+        'binderhub_url': 'https://mybinder.org',
+        'branch': 'master',
+        'dependencies': ['../requirements-build-docs.txt',
+                         'binder/requirements.txt'],
+        'notebooks_dir': 'examples'
     }
+}
 
 # Get rid of spurious warnings due to some interaction between
 # autosummary and numpydoc. See
 # https://github.com/phn/pytpm/issues/3#issuecomment-12133978 for more
 # details
 numpydoc_show_class_members = False
 
+
 def touch_example_backreferences(app, what, name, obj, options, lines):
     # generate empty examples files, so that we don't get
     # inclusion errors if there are no examples for a class / module
diff --git a/doc/themes/nilearn/static/nature.css_t b/doc/themes/nilearn/static/nature.css_t
@@ -1708,3 +1708,14 @@ div.sg-report iframe {
     margin-bottom: 0pt;
     width: 126%; /* More than 100% because of .8 scaling */
 }
+
+/* gallery download note */
+
+div.body div.sphx-glr-download-link-note {
+    text-align: left;
+    float: none;
+    margin: 10px 0 -10px 0;
+    border-radius: 4px;
+    padding: 5px;
+    max-width: 100%;
+}
diff --git a/doc/whats_new.rst b/doc/whats_new.rst
@@ -1,3 +1,22 @@
+0.6.2
+======
+
+ENHANCEMENTS
+------------
+
+- Generated documentation now includes Binder links to launch examples interactively
+  in the browser
+
+Contributors
+------------
+
+The following people contributed to this release::
+
+     Elizabeth DuPre
+     Zvi Baratz
+     Kshitij Chawla (kchawla-pi)
+
+
 0.6.1
 =====
 
diff --git a/requirements-build-docs.txt b/requirements-build-docs.txt
@@ -1,5 +1,4 @@
 numpy
-pandas
 cython
 scipy
 flake8
@@ -14,4 +13,4 @@ pandas
 nibabel
 scikit-learn
 joblib
-matplotlib
+matplotlib

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+-r ./requirements-build-docs.txt`
	`2`	`+nilearn>=0.6.1`