Skip to content

Commit d91f9ae

Browse files
authored
Merge pull request #126 from mgxd/doc/notebooks
DOC: Add example notebooks to sphinx documentation
2 parents 30d3b17 + 2e911fd commit d91f9ae

7 files changed

+384
-5395
lines changed

docs/conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
"sphinx.ext.mathjax",
3838
"sphinx.ext.napoleon",
3939
"sphinx.ext.viewcode",
40+
"nbsphinx",
4041
]
4142

4243
autodoc_mock_imports = [

docs/examples.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
========
2+
Examples
3+
========
4+
5+
A collection of Jupyter Notebooks to serve as interactive tutorials.
6+
7+
.. toctree::
8+
:maxdepth: 1
9+
10+
notebooks/01_preparing_images
11+
notebooks/02_afni_deoblique
12+
notebooks/isbi2020

docs/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,9 @@ Contents
4949
--------
5050

5151
.. toctree::
52-
:maxdepth: 3
52+
:maxdepth: 2
5353

5454
installation
55+
examples
5556
changes
5657
api

docs/notebooks/01 - Preparing images.ipynb docs/notebooks/01_preparing_images.ipynb

+20-13
Large diffs are not rendered by default.

docs/notebooks/02 - AFNI Deoblique.ipynb docs/notebooks/02_afni_deoblique.ipynb

+12-5
Large diffs are not rendered by default.

docs/notebooks/NiTransforms - ISBI 2020.ipynb

-5,376
This file was deleted.

docs/notebooks/isbi2020.ipynb

+337
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)