fix docs building

OpenCOMPES · Dec 20, 2024 · 7bba769 · 7bba769
1 parent 63ef4cc
commit 7bba769
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 6 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -54,6 +54,8 @@ jobs:
           cp -r $GITHUB_WORKSPACE/tutorial $GITHUB_WORKSPACE/docs/
           mkdir $GITHUB_WORKSPACE/docs/tests
           cp -r $GITHUB_WORKSPACE/tests/data $GITHUB_WORKSPACE/docs/tests/
+          mkdir -p $GITHUB_WORKSPACE/docs/src/specsscan
+          cp -r $GITHUB_WORKSPACE/src/specsscan/config $GITHUB_WORKSPACE/docs/src/specsscan
 
       - name: Change version for develop build
         if: startsWith(github.ref, 'refs/heads/') && github.ref != 'refs/heads/main'
@@ -95,7 +97,7 @@ jobs:
       - name: Set up Python 3.10
         uses: actions/setup-python@v5
         with:
-          python-version: 3.10
+          python-version: "3.10"
 
       - name: Setup SSH
         uses: webfactory/ssh-agent@v0.9.0
@@ -124,7 +126,7 @@ jobs:
 
       - name: Update switcher.json
         run: |
-          VERSION=`grep "<title>Specsanalyzer documentation." sphinx-docs/index.html | sed -n 's/.*SED \(.*\) documentation.*/\1/p'`
+          VERSION=`grep "<title>" sphinx-docs/index.html | sed -n 's/.*specsanalyzer \(.*\) documentation.*/\1/p'`
           echo "python docs-repo/specsanalyzer/update_switcher.py docs-repo/specsanalyzer/switcher.json $GITHUB_REF $VERSION"
           python docs-repo/specsanalyzer/update_switcher.py docs-repo/specsanalyzer/switcher.json $GITHUB_REF $VERSION
 

diff --git a/src/specsanalyzer/convert.py b/src/specsanalyzer/convert.py
@@ -91,7 +91,7 @@ def get_damatrix_from_calib2d(
         dims = ["Position", "Ekin"]
 
     else:
-        raise ValueError(f"Unrecognized lens mode '{lens_mode}")
+        raise ValueError(f"Unrecognized lens mode '{lens_mode}'")
 
     return a_inner, da_matrix, retardation_ratio, source, dims
 

diff --git a/src/specsscan/config/example_config_FHI.yaml b/src/specsscan/config/example_config_FHI.yaml
@@ -57,7 +57,7 @@ nexus:
   # the NeXus definition to use
   definition: "NXmpes_arpes"
   # additional input files, e.g. config and ELN files
-  input_files: ["../specsscan/config/NXmpes_arpes_config.json"]
+  input_files: ["../src/specsscan/config/NXmpes_arpes_config.json"]
 
 # parameters for the SpecsAnalyzer
 spa_params:

diff --git a/tutorial/3_specsscan_conversion_to_NeXus.ipynb b/tutorial/3_specsscan_conversion_to_NeXus.ipynb
@@ -125,7 +125,7 @@
    "outputs": [],
    "source": [
     "config = {\"nexus\":{\"definition\": \"NXmpes_arpes\"}, \"spa_params\":{\"crop\":True, \"ek_range_min\":0.07597844332538181, \"ek_range_max\":0.9117413199045858, \"ang_range_min\":0.16453159041394336, \"ang_range_max\":0.8840087145969499,}}\n",
-    "sps = SpecsScan(config=config, user_config=\"../specsscan/config/example_config_FHI.yaml\")\n",
+    "sps = SpecsScan(config=config, user_config=\"../src/specsscan/config/example_config_FHI.yaml\")\n",
     "path = \"../tests/data/\" # Path to the test data set"
    ]
   },

diff --git a/tutorial/4_specsscan_load_sweep_scan.ipynb b/tutorial/4_specsscan_load_sweep_scan.ipynb
@@ -48,7 +48,7 @@
     "    \"rotation_angle\": 2,\n",
     "    \"crop\":True,\n",
     "}}\n",
-    "sps = SpecsScan(config=config, user_config=\"../specsscan/config/example_config_FHI.yaml\")\n",
+    "sps = SpecsScan(config=config, user_config=\"../src/specsscan/config/example_config_FHI.yaml\")\n",
     "path = \"../tests/data/\" # Path to the test data set"
    ]
   },