From 0cdfc90aef5556db7fbd90202be765eec6ed870b Mon Sep 17 00:00:00 2001 From: rettigl Date: Tue, 22 Oct 2024 21:08:06 +0200 Subject: [PATCH] add suggested review changes --- .github/workflows/documentation.yml | 2 ++ docs/advanced_topics/index.md | 13 +++++++++++++ docs/index.md | 10 ++++++++++ docs/user_guide/index.md | 2 +- docs/workflows/index.md | 2 +- 5 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 docs/advanced_topics/index.md diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 44d74bec..a453e9a9 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -117,6 +117,8 @@ jobs: run: | mkdir -p docs-repo/${{ steps.version-folder.outputs.folder }} cp -r sphinx-docs/* docs-repo/${{ steps.version-folder.outputs.folder }} + rm -rf docs-repo/${{ steps.version-folder.outputs.folder }}/.doctrees + rm -rf docs-repo/${{ steps.version-folder.outputs.folder }}/tutorial/*.ipynb - name: Push changes run: | diff --git a/docs/advanced_topics/index.md b/docs/advanced_topics/index.md new file mode 100644 index 00000000..82a6d02c --- /dev/null +++ b/docs/advanced_topics/index.md @@ -0,0 +1,13 @@ +--- +myst: + html_meta: + "description lang=en": | + Advanced topics describing specific workflows and functionalities +--- +# Workflows + +```{toctree} +../tutorial/6_binning_with_time-stamped_data +../tutorial/7_correcting_orthorhombic_symmetry +../tutorial/8_jittering_tutorial +``` diff --git a/docs/index.md b/docs/index.md index 0f368f80..6b4cf732 100644 --- a/docs/index.md +++ b/docs/index.md @@ -30,6 +30,16 @@ Several example notebooks to demonstrate the functionality of SED for end-to-end workflows/index ``` +## Advanced topics + +There are also further example notebooks showing more advanced topics not required in every-day analysis. + +```{toctree} +:maxdepth: 2 + +advanced_topics/index +``` + ## API ```{toctree} diff --git a/docs/user_guide/index.md b/docs/user_guide/index.md index 489a30c6..504782d9 100644 --- a/docs/user_guide/index.md +++ b/docs/user_guide/index.md @@ -15,7 +15,7 @@ installation ```{toctree} :caption: Basic concepts ../tutorial/1_binning_fake_data -../tutorial/8_jittering_tutorial +../tutorial/2_conversion_pipeline_for_example_time-resolved_ARPES_data ../tutorial/3_metadata_collection_and_export_to_NeXus ``` diff --git a/docs/workflows/index.md b/docs/workflows/index.md index 5b63b574..eb2b6df7 100644 --- a/docs/workflows/index.md +++ b/docs/workflows/index.md @@ -7,8 +7,8 @@ myst: # Workflows ```{toctree} -../tutorial/2_conversion_pipeline_for_example_time-resolved_ARPES_data ../tutorial/4_hextof_workflow +../tutorial/8_jittering_tutorial ../tutorial/6_binning_with_time-stamped_data ../tutorial/7_correcting_orthorhombic_symmetry ```