detectors/slsDetectorPackage
24
1
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2026-01-22 19:28:54 +01:00
Code Issues Actions Packages Releases Activity

rename main_index to index

Browse Source
This commit is contained in:
mazzol_a
2026-01-13 09:36:07 +01:00
parent 1b87cbff1b
commit edc8c5ba6e
3 changed files with 25 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
docs/main_index/main_index.html → docs/main_index/index.html
View File

@@ -1,4 +1,3 @@
<!-- filepath: /home/mazzol_a/Documents/slsDetectorPackage/docs/main_index.html.j2 -->
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
@@ -19,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.1.0" href="https://slsdetectorgroup.github.io/devdoc/10.1.0/index.html" />
<link rel="next" title="10.0.0" href="https://slsdetectorgroup.github.io/devdoc/10.0.0/index.html" />
</head>
<body class="wy-body-for-nav">
@@ -44,8 +43,6 @@
<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.1.0/index.html">10.1.0</a></li>
<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/devdoc/9.2.0/index.html">9.2.0</a></li>
@@ -111,14 +108,6 @@
<tbody>
<tr class="row-odd">
<td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/releases/tag/10.1.0">10.1.0</a></p></td>
<td><p>Minor</p></td>
<td><p>12.01.25</p></td>
<td><p><a class="reference external" href="https://slsdetectorgroup.github.io/slsDetectorPackage/releases/RELEASE_v10.1.0.txt">10.1.0 Release Notes</a></p></td>
<td><p><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/10.1.0/index.html">10.1.0 Docs</a></p></td>
</tr>
<tr class="row-even">
<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>
@@ -126,7 +115,7 @@
<td><p><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/10.0.0/index.html">10.0.0 Docs</a></p></td>
</tr>
<tr class="row-odd">
<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>
@@ -134,7 +123,7 @@
<td><p><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/9.2.0/index.html">9.2.0 Docs</a></p></td>
</tr>
<tr class="row-even">
<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>
@@ -142,7 +131,7 @@
<td><p><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/9.1.1/index.html">9.1.1 Docs</a></p></td>
</tr>
<tr class="row-odd">
<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>
@@ -150,7 +139,7 @@
<td><p><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/9.1.0/index.html">9.1.0 Docs</a></p></td>
</tr>
<tr class="row-even">
<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>
@@ -158,7 +147,7 @@
<td><p><a class="reference external" href="https://slsdetectorgroup.github.io/devdoc/9.0.0/index.html">9.0.0 Docs</a></p></td>
</tr>
<tr class="row-odd">
<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>
<td><p>18.09.2024</p></td>
@@ -166,7 +155,7 @@
<td><p>&nbsp;</p></td>
</tr>
<tr class="row-even">
<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>
<td><p>16.01.2024</p></td>
@@ -174,7 +163,7 @@
<td><p>&nbsp;</p></td>
</tr>
<tr class="row-odd">
<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>
<td><p>13.11.2023</p></td>
@@ -182,7 +171,7 @@
<td><p>&nbsp;</p></td>
</tr>
<tr class="row-even">
<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>
<td><p>14.11.2023</p></td>
@@ -190,7 +179,7 @@
<td><p>&nbsp;</p></td>
</tr>
<tr class="row-odd">
<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>
<td><p>12.07.2023</p></td>
@@ -198,7 +187,7 @@
<td><p>&nbsp;</p></td>
</tr>
<tr class="row-even">
<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>
<td><p>24.03.2023</p></td>
@@ -206,7 +195,7 @@
<td><p>&nbsp;</p></td>
</tr>
<tr class="row-odd">
<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>
<td><p>24.02.2023</p></td>
@@ -214,7 +203,7 @@
<td><p>&nbsp;</p></td>
</tr>
<tr class="row-even">
<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>
<td><p>25.11.2022</p></td>
@@ -222,7 +211,7 @@
<td><p>&nbsp;</p></td>
</tr>
<tr class="row-odd">
<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>
<td><p>04.01.2022</p></td>
@@ -230,7 +219,7 @@
<td><p>&nbsp;</p></td>
</tr>
<tr class="row-even">
<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>
<td><p>25.11.2021</p></td>
@@ -238,7 +227,7 @@
<td><p>&nbsp;</p></td>
</tr>
<tr class="row-odd">
<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>
<td><p>20.10.2021</p></td>
@@ -246,7 +235,7 @@
<td><p>&nbsp;</p></td>
</tr>
<tr class="row-even">
<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>
<td><p>22.03.2021</p></td>
@@ -254,7 +243,7 @@
<td><p>&nbsp;</p></td>
</tr>
<tr class="row-odd">
<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>
<td><p>25.11.2020</p></td>
@@ -262,7 +251,7 @@
<td><p>&nbsp;</p></td>
</tr>
<tr class="row-even">
<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>
<td><p>18.11.2020</p></td>
@@ -271,7 +260,7 @@
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><p><a class="reference external" href="https://github.com/slsdetectorgroup/slsDetectorPackage/tree/developer">Developer</a></p></td>
<td><p>&nbsp;</p></td>
<td><p>&nbsp;</p></td>
@@ -291,7 +280,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="https://slsdetectorgroup.github.io/devdoc/10.1.0/index.html" class="btn btn-neutral float-right" title="10.1.0" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<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>
</div>
<hr/>

1
docs/main_index/main_index.html.j2 → docs/main_index/index.html.j2
View File

@@ -1,4 +1,3 @@
<!-- filepath: /home/mazzol_a/Documents/slsDetectorPackage/docs/main_index.html.j2 -->
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>

9
docs/main_index/render_main_index.py
View File

@@ -1,6 +1,5 @@
#!/usr/bin/env python3
"""
Render the main index HTML from a Jinja2 template with version data.
Render the index HTML from a Jinja2 template with version data.
Can also add new versions to the YAML data file.
Usage:
@@ -70,7 +69,7 @@ def render_template(template_path: Path, output_path: Path, data_path: Path):
def main():
parser = argparse.ArgumentParser(description='Manage versions and render main index HTML')
parser.add_argument('--data', type=Path, required=True,
parser.add_argument('--data', type=Path, default=Path("versions.yaml"),
help='Path to versions YAML data file')
# Options for adding a new version
@@ -84,9 +83,9 @@ def main():
help='New version does not have documentation')
# Options for rendering
parser.add_argument('--template', type=Path,
parser.add_argument('--template', type=Path, default=Path("index.html.j2"),
help='Path to Jinja2 template file')
parser.add_argument('--output', type=Path,
parser.add_argument('--output', type=Path, default=Path("index.html"),
help='Path to output HTML file')
args = parser.parse_args()