Skip to content

Commit

Permalink
add suggested review changes
Browse files Browse the repository at this point in the history
  • Loading branch information
rettigl committed Oct 22, 2024
1 parent 6c7b6a0 commit 0cdfc90
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
13 changes: 13 additions & 0 deletions docs/advanced_topics/index.md
Original file line number Diff line number Diff line change
@@ -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
```
10 changes: 10 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
2 changes: 1 addition & 1 deletion docs/workflows/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit 0cdfc90

Please sign in to comment.