Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Add example notebooks to sphinx documentation #126

Merged
merged 5 commits into from
Jul 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"sphinx.ext.mathjax",
"sphinx.ext.napoleon",
"sphinx.ext.viewcode",
"nbsphinx",
]

autodoc_mock_imports = [
Expand Down
12 changes: 12 additions & 0 deletions docs/examples.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
========
Examples
========

A collection of Jupyter Notebooks to serve as interactive tutorials.

.. toctree::
:maxdepth: 1

notebooks/01_preparing_images
notebooks/02_afni_deoblique
notebooks/isbi2020
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,9 @@ Contents
--------

.. toctree::
:maxdepth: 3
:maxdepth: 2

installation
examples
changes
api

Large diffs are not rendered by default.

Large diffs are not rendered by default.

5,376 changes: 0 additions & 5,376 deletions docs/notebooks/NiTransforms - ISBI 2020.ipynb

This file was deleted.

337 changes: 337 additions & 0 deletions docs/notebooks/isbi2020.ipynb

Large diffs are not rendered by default.