Merge pull request #322 from thewtex/sphinx-update

ENH: Update Sphinx to 4.4.0

Author: thewtex

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

@@ -262,7 +262,10 @@ jobs:
             cmake-build-type: "Release"
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
+        with:
+          path: Ex
+          submodules: recursive
 
       - name: Set up Python 3.8
         uses: actions/setup-python@v1
@@ -282,10 +285,9 @@ jobs:
 
           python -m pip install --upgrade pip
           python -m pip install ninja
-          python -m pip install sphinx==3.0.4
+          python -m pip install 'sphinx==4.4.0' 'docutils<0.18'
           python -m pip install --ignore-installed six
           python -m pip install ipython
-          python -m pip install nbsphinx
 
       - name: Remove Duplicate Declaration Warnings
         run: |
@@ -309,26 +311,27 @@ jobs:
 
       - name: Fetch CTest driver script
         run: |
-          curl -L https://raw.githubusercontent.com/InsightSoftwareConsortium/ITK/dashboard/itk_common.cmake -O
+          curl -L https://raw.githubusercontent.com/InsightSoftwareConsortium/ITKSphinxExamples/dashboard/itkexamples_common.cmake -O
 
       - name: Configure CTest script
         shell: bash
         run: |
+          mv Ex ../../
           operating_system="${{ matrix.os }}"
           cat > dashboard.cmake << EOF
           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}/ITKSphinxExamples-build" CTEST_BINARY_DIRECTORY)
-          set(dashboard_source_name "${GITHUB_REPOSITORY}")
+          file(TO_CMAKE_PATH "\$ENV{GITHUB_WORKSPACE}/.." CTEST_DASHBOARD_ROOT)
+          file(TO_CMAKE_PATH "\$ENV{GITHUB_WORKSPACE}/../../Ex" CTEST_SOURCE_DIRECTORY)
+          file(TO_CMAKE_PATH "\$ENV{GITHUB_WORKSPACE}/../../bld/" CTEST_BINARY_DIRECTORY)
+          set(dashboard_superbuild 1)
           if(ENV{GITHUB_REF} MATCHES "master")
             set(branch "-master")
             set(dashboard_model "Continuous")
           else()
             set(branch "-${GITHUB_REF}")
             set(dashboard_model "Experimental")
           endif()
-          set(CTEST_BUILD_NAME "${GITHUB_REPOSITORY}-${operating_system}-\${branch}")
+          set(CTEST_BUILD_NAME "${GITHUB_REPOSITORY}-${operating_system}-\${branch}-docs")
           set(CTEST_UPDATE_VERSION_ONLY 1)
           set(CTEST_TEST_ARGS \${CTEST_TEST_ARGS} PARALLEL_LEVEL \${PARALLEL_LEVEL})
           set(CTEST_BUILD_CONFIGURATION "Release")
@@ -341,15 +344,17 @@ jobs:
           set(dashboard_no_clean 1)
           set(ENV{CC} ${{ matrix.c-compiler }})
           set(ENV{CXX} ${{ matrix.cxx-compiler }})
+          if(WIN32)
+            set(ENV{PATH} "\${CTEST_DASHBOARD_ROOT}/ITK-build/bin;\$ENV{PATH}")
+          endif()
           set(dashboard_cache "
-          ITK_DIR:PATH=\${CTEST_DASHBOARD_ROOT}/ITK-build
           BUILD_TESTING:BOOL=ON
           BUILD_DOCUMENTATION:BOOL=ON
           ")
           string(TIMESTAMP build_date "%Y-%m-%d")
           message("CDash Build Identifier: \${build_date} \${CTEST_BUILD_NAME}")
           message("CTEST_SITE = \${CTEST_SITE}")
-          include(\${CTEST_SCRIPT_DIRECTORY}/itk_common.cmake)
+          include(\${CTEST_SCRIPT_DIRECTORY}/itkexamples_common.cmake)
           EOF
           cat dashboard.cmake
 
@@ -362,14 +367,14 @@ jobs:
         with:
           name: Documentation
           path: |
-            ${{ github.workspace }}/ITKSphinxExamples-build/ITKSphinxExamples-*-html.tar.gz
-            ${{ github.workspace }}/ITKSphinxExamples-build/ITKSphinxExamples-*-html.zip
+            ${{ github.workspace }}/../../bld/ITKEx-build/ITKSphinxExamples-*-html.tar.gz
+            ${{ github.workspace }}/../../bld/ITKEx-build/ITKSphinxExamples-*-html.zip
 
       - name: Unpack site
         shell: bash
         run: |
           mkdir site
-          tar --strip-components=1 -xf ${{ github.workspace }}/ITKSphinxExamples-build/ITKSphinxExamples-*-html.tar.gz -C site
+          tar --strip-components=1 -xf ${{ github.workspace }}/../../ITKEx-build/ITKSphinxExamples-*-html.tar.gz -C site
 
       - name: Publish website to Netlify
         uses: nwtgck/actions-netlify@v1.1.13

.gitmodules

@@ -4,9 +4,6 @@
 [submodule "Utilities/SphinxExtensions/breathe"]
 	path = Utilities/SphinxExtensions/breathe
 	url = https://github.com/michaeljones/breathe
-[submodule "Utilities/SphinxExtensions/gitstats"]
-	path = Utilities/SphinxExtensions/gitstats
-	url = https://github.com/arnaudgelas/gitstats.git
 [submodule "Utilities/SphinxExtensions/sphinx-bootstrap-theme"]
 	path = Utilities/SphinxExtensions/sphinx-bootstrap-theme
 	url = https://github.com/ryan-roemer/sphinx-bootstrap-theme

CMakeLists.txt

@@ -251,16 +251,6 @@ if(BUILD_DOCUMENTATION)
   # was built before build_html.
   add_dependencies(copy_sources ITKSphinxExamplesData)
 
-  configure_file("${ITKSphinxExamples_SOURCE_DIR}/Utilities/SphinxExtensions/RunGitStats.cmake.in"
-    "${ITKSphinxExamples_BINARY_DIR}/Utilities/SphinxExtensions/RunGitStats.cmake"
-    @ONLY)
-  add_custom_target(gitstats ALL
-    COMMAND ${CMAKE_COMMAND} -P "${ITKSphinxExamples_BINARY_DIR}/Utilities/SphinxExtensions/RunGitStats.cmake"
-    WORKING_DIRECTORY ${ITKSphinxExamples_BINARY_DIR}
-    COMMENT "Running gitstats"
-    )
-  add_dependencies(gitstats copy_sources)
-
   # A high level target that the individual targets depend on.
   add_custom_target(CreateDownloadableArchives ALL
     ${CMAKE_COMMAND} -E echo "Done creating individual example downloadable archives..."
@@ -282,7 +272,7 @@ if(BUILD_DOCUMENTATION)
   set(SPHINX_CONF_DIR ${ITKSphinxExamples_BINARY_DIR}/Formatting)
   set(SPHINX_INPUT_DIR ${ITKSphinxExamples_BINARY_DIR})
   set(SPHINX_DESTINATION ${ITKSphinxExamples_BINARY_DIR})
-  set(SPHINX_DEPENDENCIES gitstats ITKDoxygenXML ITKSphinxExamplesData ITKDoxygenTAG CreateDownloadableArchives)
+  set(SPHINX_DEPENDENCIES ITKDoxygenXML ITKSphinxExamplesData ITKDoxygenTAG CreateDownloadableArchives)
 
   option(DOC_WITH_LOCAL_DOXYGEN "Generate documentation with local doxygen" OFF)
   mark_as_advanced(DOC_WITH_LOCAL_DOXYGEN)

Documentation/Credits.rst

@@ -1,12 +1,9 @@
 Credits
 ==========
 
-.. toctree::
-   :maxdepth: 2
-
-   gitstats/index
-   gitstats/authors
-   gitstats/activity
-   gitstats/files
-   gitstats/lines
-   gitstats/tags
+.. contributors:: InsightSoftwareConsortium/ITKSphinxExamples
+    :contributions:
+    :avatars:
+    :exclude: itkrobot
+    :limit: 100
+    :order: DESC

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', 'sphinx.ext.imgconverter', 'breathe', 'doxylink', 'breathelink', 'nbsphinx']
+    'sphinx.ext.viewcode', 'sphinx.ext.imgconverter', 'breathe', 'doxylink', 'breathelink', 'nbsphinx', 'sphinx_contributors']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['templates']

Superbuild/External-Python.cmake

@@ -17,6 +17,6 @@ ExternalProject_Add(ITKPython
   DOWNLOAD_COMMAND ""
   CONFIGURE_COMMAND ${PYTHON_EXECUTABLE} -m venv "${_itk_venv}"
   BUILD_COMMAND ${ITKPYTHON_EXECUTABLE} -m pip install --upgrade pip
-  INSTALL_COMMAND ${ITKPYTHON_EXECUTABLE} -m pip install --ignore-installed itk>=5.2.0.post2 sphinx==3.0.4 six black nbsphinx ipython
+  INSTALL_COMMAND ${ITKPYTHON_EXECUTABLE} -m pip install --ignore-installed itk>=5.2.0.post2 sphinx==4.4.0 docutils<0.18 six black nbsphinx ipython sphinx-contributors
   COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/ITKBlackConfig.cmake
   )

Superbuild/Superbuild.cmake

@@ -88,7 +88,6 @@ if(BUILD_DOCUMENTATION)
     "-DSPHINX_DEVHELP_OUTPUT:BOOL=${SPHINX_DEVHELP_OUTPUT}"
     "-DSPHINX_DIRHTML_OUTPUT:BOOL=${SPHINX_DIRHTML_OUTPUT}"
     "-DSPHINX_EPUB_OUTPUT:BOOL=${SPHINX_EPUB_OUTPUT}"
-    "-DSPHINX_HTMLHELP_OUTPUT:BOOL=${SPHINX_HTMLHELP_OUTPUT}"
     "-DSPHINX_HTML_OUTPUT:BOOL=${SPHINX_HTML_OUTPUT}"
     "-DSPHINX_LATEX_OUTPUT:BOOL=${SPHINX_LATEX_OUTPUT}"
     "-DSPHINX_MAN_OUTPUT:BOOL=${SPHINX_MAN_OUTPUT}"