update docs and move to pydata scheme

.github/workflows/documentation.yml

@@ -49,7 +49,6 @@ jobs:
       - name: copy tutorial files to docs
         run: |
           cp -r $GITHUB_WORKSPACE/tutorial $GITHUB_WORKSPACE/docs/
-          cp -r $GITHUB_WORKSPACE/specsscan/config $GITHUB_WORKSPACE/docs/specsscan/
           mkdir $GITHUB_WORKSPACE/docs/tests
           cp -r $GITHUB_WORKSPACE/tests/data $GITHUB_WORKSPACE/docs/tests/
 

docs/conf.py

@@ -23,7 +23,7 @@ def _get_project_meta():
     with open("../pyproject.toml") as pyproject:
         file_contents = pyproject.read()
 
-    return tomlkit.parse(file_contents)["tool"]["poetry"]
+    return tomlkit.parse(file_contents)["project"]
 
 
 pkg_meta = _get_project_meta()
@@ -89,15 +89,36 @@ def _get_project_meta():
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "pydata_sphinx_theme"
+
+html_theme_options = {
+    "github_url": "https://github.com/OpenCOMPES/specsanalyzer",
+    "primary_sidebar_end": ["indices.html"],
+    "navbar_center": ["version-switcher", "navbar-nav"],
+    "show_nav_level": 2,
+    "show_version_warning_banner": True,
+    # maybe better to use _static/switcher.json on github pages link instead of the following
+    "switcher": {
+        "json_url": "https://raw.githubusercontent.com/OpenCOMPES/docs/main/specsanalyzer/switcher.json",
+        "version_match": version,
+    },
+    "content_footer_items": ["last-updated"],
+}
+
+html_context = {
+    "github_user": "OpenCOMPES",
+    "github_repo": "specsanalyzer",
+    "github_version": "main",
+    "doc_path": "docs",
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/specsanalyzer/config.rst

@@ -23,17 +23,17 @@ API
 Default specsanalyzer configuration settings
 ***************************************************
 
-.. literalinclude:: ../../specsanalyzer/config/default.yaml
+.. literalinclude:: ../../src/specsanalyzer/config/default.yaml
    :language: yaml
 
 Default specsscan configuration settings
 ***************************************************
 
-.. literalinclude:: ../../specsscan/config/default.yaml
+.. literalinclude:: ../../src/specsscan/config/default.yaml
    :language: yaml
 
 Example configuration file for the trARPES setup at FHI-Berlin
 *********************************************************************************
 
-.. literalinclude:: ../../specsscan/config/example_config_FHI.yaml
+.. literalinclude:: ../../src/specsscan/config/example_config_FHI.yaml
    :language: yaml

src/specsanalyzer/core.py

@@ -495,10 +495,10 @@ def crop_tool(
         )
 
         def update(hline, vline, v_vals):
-            lineh1.set_ydata(hline[0])
-            lineh2.set_ydata(hline[1])
-            linev1.set_xdata(vline[0])
-            linev2.set_xdata(vline[1])
+            lineh1.set_ydata([hline[0]])
+            lineh2.set_ydata([hline[1]])
+            linev1.set_xdata([vline[0]])
+            linev2.set_xdata([vline[1]])
             mesh_obj.set_clim(vmin=v_vals[0], vmax=v_vals[1])
             fig.canvas.draw_idle()