docs: added documentation

Author: henryborchers

vars/runJenkinsPipeline.groovy

@@ -107,6 +107,28 @@ def call(){
                                             )
                                         }
                                     }
+                                    stage('Building Documentation'){
+                                        steps {
+                                            catchError(buildResult: 'UNSTABLE', message: 'Building Sphinx documentation has issues', stageResult: 'UNSTABLE') {
+                                                sh(label: 'Running Sphinx',
+                                                    script: 'uv run -m sphinx -b html docs build/docs/html -d build/docs/doctrees -v -w logs/build_sphinx.log -W --keep-going'
+                                                )
+                                            }
+                                        }
+                                        post{
+                                            always {
+                                                recordIssues(tools: [sphinxBuild(name: 'Sphinx Documentation Build', pattern: 'logs/build_sphinx.log', id: 'sphinx_build')])
+                                            }
+                                            success{
+                                                publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: false, reportDir: 'build/docs/html', reportFiles: 'index.html', reportName: 'Documentation', reportTitles: ''])
+                                                script{
+                                                    def props = readTOML( file: 'pyproject.toml')['project']
+                                                    zip archive: true, dir: 'build/docs/html', glob: '', zipFile: "dist/${props.name}-${props.version}.doc.zip"
+                                                }
+                                                stash includes: 'dist/*.doc.zip,build/docs/html/**', name: 'DOCS_ARCHIVE'
+                                            }
+                                        }
+                                    }
                                     stage('Running Tests'){
                                         parallel {
                                             stage('PyTest'){