Merge pull request #187 from mseng10/modernize-documentation

Author: thewtex

.github/workflows/build-test.yml

@@ -328,7 +328,8 @@ jobs:
 
       - name: Remove Duplicate Declaration Warnings
         run: |
-          sed -i "6559d" /opt/hostedtoolcache/Python/3.8.6/x64/lib/python3.8/site-packages/sphinx/domains/cpp.py
+          SITE_PACKAGES_DIR=$(python3 "-c" "from distutils import sysconfig; print(sysconfig.get_python_lib())")
+          sed -i "6559d" ${SITE_PACKAGES_DIR}/sphinx/domains/cpp.py
 
       - name: Download ITK
         run: |
@@ -357,7 +358,7 @@ jobs:
           set(CTEST_SITE "GitHubActions")
           file(TO_CMAKE_PATH "${GITHUB_WORKSPACE}/.." CTEST_DASHBOARD_ROOT)
           file(TO_CMAKE_PATH "${GITHUB_WORKSPACE}/" CTEST_SOURCE_DIRECTORY)
-          file(TO_CMAKE_PATH "${GITHUB_WORKSPACE}/../build" CTEST_BINARY_DIRECTORY)
+          file(TO_CMAKE_PATH "${GITHUB_WORKSPACE}/ITKExamples-build" CTEST_BINARY_DIRECTORY)
           set(dashboard_source_name "${GITHUB_REPOSITORY}")
           if(ENV{GITHUB_REF} MATCHES "master")
             set(branch "-master")
@@ -394,3 +395,11 @@ jobs:
       - name: Build and test
         run: |
           ctest -j 2 -VV -S dashboard.cmake
+
+      - name: Publish Documentation html as GitHub Artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: Documentation
+          path: |
+            ${{ github.workspace }}/ITKExamples-build/ITKExamples-5.2.0-html.tar.gz
+            ${{ github.workspace }}/ITKExamples-build/ITKExamples-5.2.0-html.zip

Documentation/Build/index.rst

@@ -226,19 +226,6 @@ Paraview
   Paraview_
 
 
-QGoImageCompare
-  QGoImageCompare_ is a simple Qt_/VTK_ application capable of comparing multiple
-  images simultaneous by coupling the cameras views.  It is also possible to
-  interactively probe the location and value of pixels for both 2D and 3D
-  datasets.
-
-.. figure:: QGoImageCompare.png
-  :alt: QGoImageCompare
-  :align: center
-
-  QGoImageCompare_
-
-
 VV
   VV_ is an image viewer designed for fast and simple visualization of
   spatio-temporal images: 2D, 2D+t, 3D and 3D+t (or 4D) images.
@@ -258,7 +245,6 @@ VV
 .. _ITK-SNAP:              http://www.itksnap.org/pmwiki/pmwiki.php
 .. _MITK:                  http://www.mitk.org/wiki/MITK
 .. _Paraview:              https://www.paraview.org/
-.. _QGoImageCompare:       https://github.com/gofigure2/QGoImageCompare
 .. _Qt:                    https://www.qt.io/developers/
 .. _VTK:                   https://vtk.org/
 .. _VV:                    https://www.creatis.insa-lyon.fr/rio/vv

src/Core/Common/InPlaceFilterOfImage/Documentation.rst

@@ -22,6 +22,7 @@ Results
    :alt: QuickView output.
 
    Output In QuickView
+
 Code
 ----
 

src/Core/ImageFunction/ResampleSegmentedImage/Documentation.rst

@@ -13,9 +13,10 @@ Resample (stretch or compress) a segmented image.
 
 Results
 -------
-.. figure:: Yinyang.png
+
+.. figure:: Gourds.png
    :scale: 50%
-   :alt: Input yin-yang image.
+   :alt: Input image.
 
    Input Image
 

src/Core/Transform/MutualInformationAffine/Documentation.rst

@@ -14,20 +14,18 @@ Global registration by maximizing the mutual information and using an affine tra
 
 Results
 -------
+
 .. figure:: fixed.png
-  :scale: 70%
   :alt: fixed.png
 
   fixed.png
 
 .. figure:: moving.png
-  :scale: 70%
   :alt: moving.png
 
   moving.png
 
 .. figure:: OutputBaseline.png
-  :scale: 70%
   :alt: OutputBaseline.png
 
   OutputBaseline.png

src/Core/Transform/MutualInformationAffine/OutputBaseline.png.sha512

@@ -0,0 +1 @@
+46a0c840567a4eee4a3150674d78fecf7d0395c61c7de697218c0b408919587e4a39f7c307b7bbe144613e0c72bf8eb45f3f59a6b140f1b443bffa0a611aae1e

src/Core/Transform/MutualInformationAffine/outputBaseline.png.sha512

@@ -12,6 +12,7 @@ An optimizer that fully samples a grid on the parametric space.
 
 Results
 -------
+
 .. note::
    **Help Wanted**
    Implementation of Results for sphinx examples containing this message.
@@ -28,10 +29,11 @@ C++
    :lines: 18-
 
 Python
-...
+......
 
 .. literalinclude:: Code.py
-	:lines: 20-
+   :language: python
+   :lines: 20-
 
 Jupyter Notebook
 -----------------

src/Numerics/Optimizers/ExhaustiveOptimizer/Documentation.rst

@@ -15,30 +15,33 @@ Index
 Synopsis
 --------
 
-Register two point sets with the Jensen-Havrda-Charvat-Tsallis point set 
+Register two point sets with the Jensen-Havrda-Charvat-Tsallis point set
 metric.
 
 Results
 --------
-It: 0    metric value: -0.0641355
-It: 1    metric value: -0.0955508
-It: 2    metric value: -0.0956365
-It: 3    metric value: -0.0956648
-It: 4    metric value: -0.0956742
-It: 5    metric value: -0.0956774
-It: 6    metric value: -0.0956784
-It: 7    metric value: -0.0956788
-It: 8    metric value: -0.0956789
-It: 9    metric value: -0.0956789
-numberOfIterations: 10
-Moving-source final value: -0.0956789
-Moving-source final position: [0.9999999481711049, 3.6956646020565954e-9,
-                            -3.9958144654776e-8, 1.0000000021678688,
-                            1.9991709056354183, 1.999169080146488]
-Optimizer scales: [10000, 9998.46502472856, 
-                    10000, 9998.46502472848, 
-                    1.0000000000010232, 1.0000000000010232]
-Optimizer learning rate: 164.938
+
+::
+
+  It: 0    metric value: -0.0641355
+  It: 1    metric value: -0.0955508
+  It: 2    metric value: -0.0956365
+  It: 3    metric value: -0.0956648
+  It: 4    metric value: -0.0956742
+  It: 5    metric value: -0.0956774
+  It: 6    metric value: -0.0956784
+  It: 7    metric value: -0.0956788
+  It: 8    metric value: -0.0956789
+  It: 9    metric value: -0.0956789
+  numberOfIterations: 10
+  Moving-source final value: -0.0956789
+  Moving-source final position: [0.9999999481711049, 3.6956646020565954e-9,
+                                 -3.9958144654776e-8, 1.0000000021678688,
+                                 1.9991709056354183, 1.999169080146488]
+  Optimizer scales: [10000, 9998.46502472856,
+                     10000, 9998.46502472848,
+                     1.0000000000010232, 1.0000000000010232]
+  Optimizer learning rate: 164.938
 
 Code
 --------
@@ -64,4 +67,4 @@ Classes demonstrated
 --------------------
 
 .. breathelink:: itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4
-.. breathelink:: itk::GradientDescentOptimizerv4
+.. breathelink:: itk::GradientDescentOptimizerv4Template

src/Registration/Metricsv4/RegisterTwoPointSets/Documentation.rst

@@ -5,3 +5,4 @@ Metricsv4
   :maxdepth: 1
 
   PerformRegistrationOnVectorImages/Documentation.rst
+  RegisterTwoPointSets/Documentation.rst