ENH: Build notebook docs with nbsphinx

Author: tbirdso

.github/workflows/build-test-publish.yml

@@ -255,7 +255,7 @@ jobs:
           - os: ubuntu-18.04
             c-compiler: "gcc"
             cxx-compiler: "g++"
-            itk-git-tag: "v5.2rc03"
+            itk-git-tag: "7548a390d71dc25b80e792703ee3cfea17853a99"
             cmake-build-type: "Release"
 
     steps:
@@ -274,11 +274,14 @@ jobs:
           sudo apt-get update
           sudo apt-get install gnuplot dvipng
           sudo apt-get install texlive-full
+          sudo apt-get install pandoc
 
           python -m pip install --upgrade pip
           python -m pip install ninja
           python -m pip install sphinx==3.0.4
           python -m pip install --ignore-installed six
+          python -m pip install ipython
+          python -m pip install nbsphinx
 
       - name: Remove Duplicate Declaration Warnings
         run: |

CMakeLists.txt

@@ -277,6 +277,7 @@ if(BUILD_DOCUMENTATION)
   # Builds the documentation.
   find_package(PythonInterp REQUIRED)
   find_package(Sphinx REQUIRED)
+  find_program(PANDOC_BIN pandoc REQUIRED)
 
   set(SPHINX_CONF_DIR ${ITKExamples_BINARY_DIR}/Formatting)
   set(SPHINX_INPUT_DIR ${ITKExamples_BINARY_DIR})

Formatting/conf.py.in

@@ -42,7 +42,7 @@ primary_domain = 'cpp'
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.todo', 'sphinx.ext.imgmath', 'sphinx.ext.ifconfig',
-    'sphinx.ext.viewcode', 'breathe', 'doxylink', 'breathelink']
+    'sphinx.ext.viewcode', 'breathe', 'doxylink', 'breathelink', 'nbsphinx']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['templates']

src/Core/Transform/MutualInformationAffine/Documentation.rst

@@ -6,6 +6,11 @@ Mutual Information Affine
    single: MutualInformationImageToImageMetric
    single: GradientDescentOptimizer
 
+.. toctree::
+  :maxdepth: 1
+   
+  MutualInformationAffine.ipynb
+
 Synopsis
 --------
 

src/Numerics/Optimizers/ExhaustiveOptimizer/Documentation.rst

@@ -3,6 +3,11 @@ Exhaustive Optimizer
 
 .. index::
    single: ExhaustiveOptimizer
+   
+.. toctree::
+  :maxdepth: 1
+   
+  PlotExhaustiveOptimizer.ipynb
 
 Synopsis
 --------

src/Registration/Common/MutualInformation/Documentation.rst

@@ -4,6 +4,11 @@ Mutual Information
 .. index::
    single: MutualInformationImageToImageMetric
    single: TranslationTransform
+   
+.. toctree::
+  :maxdepth: 1
+   
+  MutualInformation.ipynb
 
 Synopsis
 --------

src/Registration/Metricsv4/RegisterTwoPointSets/Documentation.rst

@@ -12,6 +12,11 @@ Index
 
 .. seealso:: registration; transformation; pointset
 
+.. toctree::
+  :maxdepth: 1
+   
+  RegisterTwoPointSets.ipynb
+
 Synopsis
 --------