Merge pull request #554 from UIUCLibrary/docs-checker

Docs checker
UIUCLibrary · Dec 2, 2024 · 0fd6122 · 0fd6122
2 parents 54a9c16 + f1aea66
commit 0fd6122
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 109 deletions.
diff --git a/docs/source/build_installer/build_installer.rst b/docs/source/build_installer/build_installer.rst
diff --git a/docs/source/build_installer/cmake_build.png b/docs/source/build_installer/cmake_build.png
diff --git a/docs/source/build_installer/cmake_configure.png b/docs/source/build_installer/cmake_configure.png
diff --git a/docs/source/build_installer/new_directory.png b/docs/source/build_installer/new_directory.png
diff --git a/docs/source/development.rst b/docs/source/development.rst
@@ -5,6 +5,5 @@ Developer’s Guide
    :maxdepth: 3
 
    plugin_development/develop_plugins
-   build_installer/build_installer
    api_reference
 
diff --git a/vars/runJenkinsPipeline.groovy b/vars/runJenkinsPipeline.groovy
@@ -288,6 +288,18 @@ def call(){
                                                     }
                                                 }
                                             }
+                                            stage('Run Docs linkcheck'){
+                                                steps {
+                                                    catchError(buildResult: 'SUCCESS', message: 'Sphinx docs linkcheck', stageResult: 'UNSTABLE') {
+                                                        sh(
+                                                            label: 'Running Sphinx docs linkcheck',
+                                                            script: '''. ./venv/bin/activate
+                                                                       python -m sphinx -b doctest docs/source build/docs -d build/docs/doctrees --no-color --builder=linkcheck --fail-on-warning
+                                                                       '''
+                                                            )
+                                                    }
+                                                }
+                                            }
                                             stage('Run MyPy Static Analysis') {
                                                 steps{
                                                     catchError(buildResult: 'SUCCESS', message: 'MyPy found issues', stageResult: 'UNSTABLE') {