changed page source

2026-01-22 05:54:29 +01:00 · 2026-01-13 16:07:12 +01:00
parent 15a34b4615
commit c680ed92ea
3 changed files with 103 additions and 20 deletions
--- a/.github/workflows/build_documentation.yml
+++ b/.github/workflows/build_documentation.yml
@@ -3,6 +3,10 @@ name: Build and upload Documentation
 on: 
    workflow_dispatch: 
    push: # Only for Testing change later 
+    pull_request:
+        branches:
+            - developer
+            - main
    release:
        types:
            - published
@@ -83,18 +87,21 @@ jobs:
                ref: gh-pages
                path: gh-pages
                
+            
            - name: Copy documentation and Release notes to versioned folder
+              # if: github.event_name == 'release' || (github.event_name == 'pull_request' && github.event.pull_request.merged == true)
              run: |
                VERSION="${{ steps.version.outputs.version }}"
                mkdir -p "gh-pages/${VERSION}"
                cp -r build/docs/html/. "gh-pages/${VERSION}/"
                cp build/docs/main_index/index.html "gh-pages/index.html"
+                cp build/docs/main_index/index.html gh-pages/_sources/index.html.txt
                if [ "${{ github.event_name }}" == "release" ]; then
                  cp  RELEASE.md "gh-pages/releases/RELEASE_v${VERSION}.md" 
                fi 
-            # TODO: need to update txt to md and backtrack? 
              
            - name: Commit and Push changes to gh-pages
+              # if: github.event_name == 'release' || (github.event_name == 'pull_request' && github.event.pull_request.merged == true)
              run: |
                cd gh-pages
                git config --global user.name 'github-actions'
--- a/docs/main_index/index.html
+++ b/docs/main_index/index.html
@@ -18,7 +18,7 @@
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="10.0.0" href="https://slsdetectorgroup.github.io/devdoc/10.0.0/index.html" /> 
+    <link rel="next" title="10.0.0" href="https://slsdetectorgroup.github.io/slsDetectorPackage/10.0.0/index.html" /> 
 </head>

 <body class="wy-body-for-nav"> 
@@ -43,18 +43,18 @@
              <p class="caption" role="heading"><span class="caption-text">Versions:</span></p>
 <ul>

-<li class="toctree-l1"><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/10.0.0/index.html">10.0.0</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/10.0.0/index.html">10.0.0</a></li>

-<li class="toctree-l1"><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/9.2.0/index.html">9.2.0</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/9.2.0/index.html">9.2.0</a></li>

-<li class="toctree-l1"><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/9.1.1/index.html">9.1.1</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/9.1.1/index.html">9.1.1</a></li>

-<li class="toctree-l1"><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/9.1.0/index.html">9.1.0</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/9.1.0/index.html">9.1.0</a></li>

-<li class="toctree-l1"><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/9.0.0/index.html">9.0.0</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/9.0.0/index.html">9.0.0</a></li>


-<li class="toctree-l1"><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/developer/index.html">Developer</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/developer/index.html">Developer</a></li>

 </ul>

@@ -74,7 +74,7 @@
      <li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">Welcome to slsDetectorPackage's documentation!</li>
      <li class="wy-breadcrumbs-aside">
-            <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
+            <a href="_sources/index.html.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
@@ -107,46 +107,70 @@
 </thead>
 <tbody>

+
+
+
+
 <tr class="row-odd">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/10.0.0">10.0.0</a></p></td>
  <td><p>Major</p></td>
  <td><p>10.09.2025</p></td>
  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/releases/RELEASE_v10.0.0.txt">10.0.0 Release Notes</a></p></td>
-  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/10.0.0/index.html">10.0.0 Docs</a></p></td>
+  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/10.0.0/index.html">10.0.0 Docs</a></p></td>
 </tr>

+
+
+
+
 <tr class="row-even">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/9.2.0">9.2.0</a></p></td>
  <td><p>Minor</p></td>
  <td><p>02.06.2025</p></td>
  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/releases/RELEASE_v9.2.0.txt">9.2.0 Release Notes</a></p></td>
-  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/9.2.0/index.html">9.2.0 Docs</a></p></td>
+  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/9.2.0/index.html">9.2.0 Docs</a></p></td>
 </tr>

+
+
+
+
 <tr class="row-odd">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/9.1.1">9.1.1</a></p></td>
  <td><p>Bug Fix</p></td>
  <td><p>22.05.2025</p></td>
  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/releases/RELEASE_v9.1.1.txt">9.1.1 Release Notes</a></p></td>
-  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/9.1.1/index.html">9.1.1 Docs</a></p></td>
+  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/9.1.1/index.html">9.1.1 Docs</a></p></td>
 </tr>

+
+
+
+
 <tr class="row-even">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/9.1.0">9.1.0</a></p></td>
  <td><p>Minor</p></td>
  <td><p>28.03.2025</p></td>
  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/releases/RELEASE_v9.1.0.txt">9.1.0 Release Notes</a></p></td>
-  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/9.1.0/index.html">9.1.0 Docs</a></p></td>
+  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/9.1.0/index.html">9.1.0 Docs</a></p></td>
 </tr>

+
+
+
+
 <tr class="row-odd">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/9.0.0">9.0.0</a></p></td>
  <td><p>Major</p></td>
  <td><p>26.11.2024</p></td>
  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/releases/RELEASE_v9.0.0.txt">9.0.0 Release Notes</a></p></td>
-  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/9.0.0/index.html">9.0.0 Docs</a></p></td>
+  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/9.0.0/index.html">9.0.0 Docs</a></p></td>
 </tr>

+
+
+
+
 <tr class="row-even">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/8.0.2">8.0.2</a></p></td>
  <td><p>Bug Fix</p></td>
@@ -155,6 +179,10 @@
  <td><p>&nbsp;</p></td>
 </tr>

+
+
+
+
 <tr class="row-odd">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/8.0.1">8.0.1</a></p></td>
  <td><p>Bug Fix</p></td>
@@ -163,6 +191,10 @@
  <td><p>&nbsp;</p></td>
 </tr>

+
+
+
+
 <tr class="row-even">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/8.0.0">8.0.0</a></p></td>
  <td><p>Major</p></td>
@@ -171,6 +203,10 @@
  <td><p>&nbsp;</p></td>
 </tr>

+
+
+
+
 <tr class="row-odd">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/7.0.3">7.0.3</a></p></td>
  <td><p>Bug Fix</p></td>
@@ -179,6 +215,10 @@
  <td><p>&nbsp;</p></td>
 </tr>

+
+
+
+
 <tr class="row-even">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/7.0.2">7.0.2</a></p></td>
  <td><p>Bug Fix</p></td>
@@ -187,6 +227,10 @@
  <td><p>&nbsp;</p></td>
 </tr>

+
+
+
+
 <tr class="row-odd">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/7.0.1">7.0.1</a></p></td>
  <td><p>Bug Fix</p></td>
@@ -195,6 +239,10 @@
  <td><p>&nbsp;</p></td>
 </tr>

+
+
+
+
 <tr class="row-even">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/7.0.0">7.0.0</a></p></td>
  <td><p>Major</p></td>
@@ -203,6 +251,10 @@
  <td><p>&nbsp;</p></td>
 </tr>

+
+
+
+
 <tr class="row-odd">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/6.1.2">6.1.2</a></p></td>
  <td><p>Bug Fix</p></td>
@@ -211,6 +263,10 @@
  <td><p>&nbsp;</p></td>
 </tr>

+
+
+
+
 <tr class="row-even">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/6.1.1">6.1.1</a></p></td>
  <td><p>Bug Fix</p></td>
@@ -219,6 +275,10 @@
  <td><p>&nbsp;</p></td>
 </tr>

+
+
+
+
 <tr class="row-odd">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/6.1.0">6.1.0</a></p></td>
  <td><p>Minor</p></td>
@@ -227,6 +287,10 @@
  <td><p>&nbsp;</p></td>
 </tr>

+
+
+
+
 <tr class="row-even">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/6.0.0">6.0.0</a></p></td>
  <td><p>Major</p></td>
@@ -235,6 +299,10 @@
  <td><p>&nbsp;</p></td>
 </tr>

+
+
+
+
 <tr class="row-odd">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/5.1.0">5.1.0</a></p></td>
  <td><p>Minor</p></td>
@@ -243,6 +311,10 @@
  <td><p>&nbsp;</p></td>
 </tr>

+
+
+
+
 <tr class="row-even">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/5.0.1">5.0.1</a></p></td>
  <td><p>Bug Fix</p></td>
@@ -251,6 +323,10 @@
  <td><p>&nbsp;</p></td>
 </tr>

+
+
+
+
 <tr class="row-odd">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/5.0.0">5.0.0</a></p></td>
  <td><p>Major</p></td>
@@ -265,7 +341,7 @@
  <td><p>&nbsp;</p></td>
  <td><p>&nbsp;</p></td>
  <td><p>&nbsp;</p></td>
-  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/developer/index.html">Developer Docs</a></p></td>
+  <td><p><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/developer/index.html">Developer Docs</a></p></td>
 </tr>

 </tbody>
@@ -280,7 +356,7 @@
           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="https://slsdetectorgroup.github.io/devdoc/10.0.0/index.html" class="btn btn-neutral float-right" title="10.0.0" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="https://slsdetectorgroup.github.io/slsDetectorPackage/10.0.0/index.html" class="btn btn-neutral float-right" title="10.0.0" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>
--- a/docs/main_index/index.html.j2
+++ b/docs/main_index/index.html.j2
@@ -66,7 +66,7 @@
      <li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">Welcome to slsDetectorPackage's documentation!</li>
      <li class="wy-breadcrumbs-aside">
-            <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
+            <a href="_sources/index.html.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
@@ -101,7 +101,7 @@
 {% for v in versions %}
 {# Check if version >= 10.0.0 for .md vs .txt #}
 {% set version_parts = v["version"].split('.') | map('int') | list %}
-{% set is_new_format = (version_parts[0] > 10) or (version_parts[0] == 10 and version_parts[1] >= 0 and version_parts[2] >= 0) %}
+{% set is_new_format = (version_parts[0] > 10) or (version_parts[0] == 10 and version_parts[1] > 0 and version_parts[2] > 0) %}
 {% set release_ext = '.md' if is_new_format else '.txt' %}
 <tr class="row-{{ 'even' if loop.index is even else 'odd' }}">
  <td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/{{ v["version"] }}">{{ v["version"] }}</a></p></td>
@@ -132,7 +132,7 @@
           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="https://slsdetectorgroup.github.io/devdoc/{{ versions[0]["version"] }}/index.html" class="btn btn-neutral float-right" title="{{ versions[0]["version"] }}" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="https://slsdetectorgroup.github.io/slsDetectorPackage/{{ versions[0]["version"] }}/index.html" class="btn btn-neutral float-right" title="{{ versions[0]["version"] }}" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>