From 87d975b8d0d734d44259af4e0e28262cd8058f71 Mon Sep 17 00:00:00 2001 From: Jan Janssen Date: Wed, 23 Apr 2025 14:53:21 +0200 Subject: [PATCH 1/5] Rename book to documentation --- .github/workflows/deploy.yml | 8 ++++---- .github/workflows/pipeline.yml | 8 ++++---- {book => documentation}/_config.yml | 0 {book => documentation}/_toc.yml | 2 +- {book => documentation}/arithmetic.md | 0 {book => documentation}/conclusion.md | 0 {book => documentation}/environment.yml | 2 +- {book => documentation}/evcurve.md | 0 {book => documentation}/intro.md | 0 {book => documentation}/nfdi.md | 0 10 files changed, 10 insertions(+), 10 deletions(-) rename {book => documentation}/_config.yml (100%) rename {book => documentation}/_toc.yml (96%) rename {book => documentation}/arithmetic.md (100%) rename {book => documentation}/conclusion.md (100%) rename {book => documentation}/environment.yml (62%) rename {book => documentation}/evcurve.md (100%) rename {book => documentation}/intro.md (100%) rename {book => documentation}/nfdi.md (100%) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index f8649e3..9c89233 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -13,14 +13,14 @@ jobs: with: auto-update-conda: true python-version: "3.12" - environment-file: book/environment.yml + environment-file: documentation/environment.yml auto-activate-base: false - name: Install Jupyterbook shell: bash -l {0} run: | - cp book/_config.yml . - cp book/_toc.yml . - cp book/*.md . + cp documentation/_config.yml . + cp documentation/_toc.yml . + cp documentation/*.md . jupyter-book build . --path-output public - run: mv public/_build/html public_html - run: touch public_html/.nojekyll diff --git a/.github/workflows/pipeline.yml b/.github/workflows/pipeline.yml index d67ac99..234cc8f 100644 --- a/.github/workflows/pipeline.yml +++ b/.github/workflows/pipeline.yml @@ -115,14 +115,14 @@ jobs: with: auto-update-conda: true python-version: "3.12" - environment-file: book/environment.yml + environment-file: documentation/environment.yml auto-activate-base: false - name: Install Jupyterbook shell: bash -l {0} run: | - cp book/_config.yml . - cp book/_toc.yml . - cp book/*.md . + cp documentation/_config.yml . + cp documentation/_toc.yml . + cp documentation/*.md . jupyter-book build . --path-output public - run: mv public/_build/html public_html - run: touch public_html/.nojekyll diff --git a/book/_config.yml b/documentation/_config.yml similarity index 100% rename from book/_config.yml rename to documentation/_config.yml diff --git a/book/_toc.yml b/documentation/_toc.yml similarity index 96% rename from book/_toc.yml rename to documentation/_toc.yml index 84f4011..c3bde74 100644 --- a/book/_toc.yml +++ b/documentation/_toc.yml @@ -1,4 +1,4 @@ -format: jb-book +format: jb-documentation root: README chapters: - file: intro.md diff --git a/book/arithmetic.md b/documentation/arithmetic.md similarity index 100% rename from book/arithmetic.md rename to documentation/arithmetic.md diff --git a/book/conclusion.md b/documentation/conclusion.md similarity index 100% rename from book/conclusion.md rename to documentation/conclusion.md diff --git a/book/environment.yml b/documentation/environment.yml similarity index 62% rename from book/environment.yml rename to documentation/environment.yml index ffdaf20..6d4a4c8 100644 --- a/book/environment.yml +++ b/documentation/environment.yml @@ -1,4 +1,4 @@ channels: - conda-forge dependencies: -- jupyter-book \ No newline at end of file +- jupyter-documentation \ No newline at end of file diff --git a/book/evcurve.md b/documentation/evcurve.md similarity index 100% rename from book/evcurve.md rename to documentation/evcurve.md diff --git a/book/intro.md b/documentation/intro.md similarity index 100% rename from book/intro.md rename to documentation/intro.md diff --git a/book/nfdi.md b/documentation/nfdi.md similarity index 100% rename from book/nfdi.md rename to documentation/nfdi.md From ce054a0a95c1005495ef609e2768694b23f0b69b Mon Sep 17 00:00:00 2001 From: Jan Janssen Date: Wed, 23 Apr 2025 14:54:16 +0200 Subject: [PATCH 2/5] rename CI action --- .github/workflows/pipeline.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pipeline.yml b/.github/workflows/pipeline.yml index 234cc8f..44afc1b 100644 --- a/.github/workflows/pipeline.yml +++ b/.github/workflows/pipeline.yml @@ -107,7 +107,7 @@ jobs: papermill pyiron_base.ipynb pyiron_base_out.ipynb -k "python3" papermill universal_workflow.ipynb universal_workflow_out.ipynb -k "python3" - book: + documentation: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 From 2e4f4ca6069d45b5201bc4d7c1bca283a238695f Mon Sep 17 00:00:00 2001 From: Jan Janssen Date: Wed, 23 Apr 2025 14:55:00 +0200 Subject: [PATCH 3/5] clean up actions --- .github/workflows/deploy.yml | 4 ++-- .github/workflows/pipeline.yml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 9c89233..db28f31 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -22,8 +22,8 @@ jobs: cp documentation/_toc.yml . cp documentation/*.md . jupyter-book build . --path-output public - - run: mv public/_build/html public_html - - run: touch public_html/.nojekyll + mv public/_build/html public_html + touch public_html/.nojekyll - name: Deploy 🚀 uses: JamesIves/github-pages-deploy-action@3.7.1 with: diff --git a/.github/workflows/pipeline.yml b/.github/workflows/pipeline.yml index 44afc1b..d69c786 100644 --- a/.github/workflows/pipeline.yml +++ b/.github/workflows/pipeline.yml @@ -124,5 +124,5 @@ jobs: cp documentation/_toc.yml . cp documentation/*.md . jupyter-book build . --path-output public - - run: mv public/_build/html public_html - - run: touch public_html/.nojekyll + mv public/_build/html public_html + touch public_html/.nojekyll From fd19e8e5af1566e36d5b52c6683c8c91f482c218 Mon Sep 17 00:00:00 2001 From: Jan Janssen Date: Wed, 23 Apr 2025 14:56:22 +0200 Subject: [PATCH 4/5] fix env --- documentation/environment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/environment.yml b/documentation/environment.yml index 6d4a4c8..ffdaf20 100644 --- a/documentation/environment.yml +++ b/documentation/environment.yml @@ -1,4 +1,4 @@ channels: - conda-forge dependencies: -- jupyter-documentation \ No newline at end of file +- jupyter-book \ No newline at end of file From fa5b601ad455534be34e652cf7f7f69d107f9c7b Mon Sep 17 00:00:00 2001 From: Jan Janssen Date: Wed, 23 Apr 2025 14:57:10 +0200 Subject: [PATCH 5/5] fix format --- documentation/_toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/_toc.yml b/documentation/_toc.yml index c3bde74..84f4011 100644 --- a/documentation/_toc.yml +++ b/documentation/_toc.yml @@ -1,4 +1,4 @@ -format: jb-documentation +format: jb-book root: README chapters: - file: intro.md