Documentation: Optain License & KEMField Manual Without Duplication

This commit aims to replace the license chapter with the License.md and adds a chapter for KEMField, including the manual.pdf. To implement the changes, Sphinx-SimplePDF and m2r2 for inclusion of markdown in .rst files have been added.
KATRIN-Experiment · Feb 13, 2024 · 6391ffd · 6391ffd
1 parent 1d3f3b9
commit 6391ffd
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 5 deletions.
diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml
@@ -11,7 +11,8 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Install dependencies
-      run: pip install sphinx_rtd_theme sphinx_design
+      run: pip install sphinx_rtd_theme sphinx_design m2r2 sphinx-simplepdf 
+
 
     - name: Build target "build"
       run: cd Documentation/gh-pages && make github

diff --git a/Documentation/gh-pages/Makefile b/Documentation/gh-pages/Makefile
@@ -18,7 +18,8 @@ github:
 	@rm -rf "$(HTMLDIR)"
 	@mv "$(BUILDDIR)/html" "$(HTMLDIR)"
 	@touch "$(HTMLDIR)/.nojekyll"
-
+	@mkdir "$(HTMLDIR)/kemfield"
+	@cp ../../KEMField/Documentation/manual/manual.pdf "$(HTMLDIR)/kemfield"
 .PHONY: help github Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new

diff --git a/Documentation/gh-pages/source/KEMField_manual_link.rst b/Documentation/gh-pages/source/KEMField_manual_link.rst
@@ -0,0 +1,10 @@
+KEMField 
+**********
+
+See :download:`KEMField manual <../../../KEMField/Documentation/manual/manual.pdf>`.
+
+With new pdf-include
+
+.. pdf-include:: ./kemfield/manual.pdf
+
+You can also download the manual :download:`here <../../../KEMField/Documentation/manual/manual.pdf>`.
diff --git a/Documentation/gh-pages/source/conf.py b/Documentation/gh-pages/source/conf.py
@@ -42,7 +42,10 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.graphviz',
     'sphinx_rtd_theme',
-    'sphinx_design'
+    'sphinx_design',
+    'm2r2',
+    'sphinx_simplepdf',
+
 ]
 
 extlinks = {

diff --git a/Documentation/gh-pages/source/index.rst b/Documentation/gh-pages/source/index.rst
@@ -51,9 +51,10 @@ Welcome to Kassiopeia's documentation!
     Additional Simulation Tools <tools.rst>
     Visualization Techniques <visualization.rst>
     XML Bindings <bindings.rst>
-    License <license.rst>
+    KEMField <KEMField_manual_link.rst>
+    License <linktolicense.rst>
     Authors <authors.rst>
- 
+
 
 
 

diff --git a/Documentation/gh-pages/source/linktolicense.rst b/Documentation/gh-pages/source/linktolicense.rst
@@ -0,0 +1,3 @@
+
+.. mdinclude:: ../../../LICENSE.md
+