From 0b3da5b3f4f1e1c6e2212ca89f96889db3c717f2 Mon Sep 17 00:00:00 2001 From: Zain Sohail Date: Fri, 3 Nov 2023 16:29:13 +0100 Subject: [PATCH] fix index file and action --- .github/workflows/build_deploy_docs.yml | 6 ++++-- docs/index.rst | 6 +++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build_deploy_docs.yml b/.github/workflows/build_deploy_docs.yml index f31597d4..de262286 100644 --- a/.github/workflows/build_deploy_docs.yml +++ b/.github/workflows/build_deploy_docs.yml @@ -53,12 +53,14 @@ jobs: sudo wget https://github.com/jgm/pandoc/releases/download/3.1.8/pandoc-3.1.8-1-amd64.deb sudo dpkg -i pandoc-3.1.8-1-amd64.deb + - name: copy tutorial files to docs + run: cp -r $GITHUB_WORKSPACE/tutorial $GITHUB_WORKSPACE/docs/ + - name: download WSe2 data run: | - cd $GITHUB_WORKSPACE + cd $GITHUB_WORKSPACE/docs/tutorial curl -L --output ./WSe2.zip https://zenodo.org/record/6369728/files/WSe2.zip unzip -o ./WSe2.zip -d . - rm ./WSe2.zip - name: build Sphinx docs run: poetry run sphinx-build -b html $GITHUB_WORKSPACE/docs $GITHUB_WORKSPACE/_build diff --git a/docs/index.rst b/docs/index.rst index 727f89de..6d8755b6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,9 +21,9 @@ Single-Event DataFrame (SED) documentation :numbered: :caption: Examples - ../../tutorial/1_binning_fake_data.ipynb - ../../tutorial/2_conversion_pipeline_for_example_time-resolved_ARPES_data.ipynb - ../../tutorial/3_metadata_collection_and_export_to_NeXus.ipynb + tutorial/1_binning_fake_data.ipynb + tutorial/2_conversion_pipeline_for_example_time-resolved_ARPES_data.ipynb + tutorial/3_metadata_collection_and_export_to_NeXus.ipynb .. toctree:: :maxdepth: 2