From acbdad9de54f6e48b3b1b713ca899f0330588323 Mon Sep 17 00:00:00 2001 From: Mridul Seth Date: Wed, 15 Apr 2026 09:23:55 +0200 Subject: [PATCH] Update old URLs links and update github pages URL schema --- .github/workflows/docs-deploy.yml | 5 +++-- docs/index.html | 8 ++++++-- packages/essimaging/docs/_templates/doc_version.html | 2 +- packages/essimaging/docs/about/index.md | 4 ++-- packages/essimaging/docs/conf.py | 4 ++-- packages/essimaging/docs/index.md | 4 ++-- packages/essimaging/pyproject.toml | 2 +- packages/essnmx/docs/_templates/doc_version.html | 2 +- packages/essnmx/docs/about/data_workflow_overview.md | 2 +- packages/essnmx/docs/about/index.md | 4 ++-- packages/essnmx/docs/conf.py | 3 ++- packages/essnmx/docs/index.md | 4 ++-- packages/essnmx/pyproject.toml | 6 +++--- packages/essreduce/docs/_templates/doc_version.html | 2 +- packages/essreduce/docs/about/index.md | 4 ++-- packages/essreduce/docs/conf.py | 6 +++--- packages/essreduce/docs/index.md | 4 ++-- packages/essreduce/pyproject.toml | 2 +- 18 files changed, 37 insertions(+), 31 deletions(-) diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml index 4301ba796..57145c7e2 100644 --- a/.github/workflows/docs-deploy.yml +++ b/.github/workflows/docs-deploy.yml @@ -41,10 +41,11 @@ jobs: if: ${{ inputs.publish }} run: | PACKAGE=${{ inputs.package }} + SUBPATH=${PACKAGE#ess} git fetch origin gh-pages:gh-pages || true git worktree add gh-pages-site gh-pages || mkdir -p gh-pages-site - rm -rf gh-pages-site/$PACKAGE - cp -r packages/$PACKAGE/html gh-pages-site/$PACKAGE + rm -rf gh-pages-site/$SUBPATH + cp -r packages/$PACKAGE/html gh-pages-site/$SUBPATH cp docs/index.html gh-pages-site/index.html touch gh-pages-site/.nojekyll - name: Build search index diff --git a/docs/index.html b/docs/index.html index 7eab8f64a..257a4ae9b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -153,14 +153,18 @@

ESS Data Reduction

Packages
- +
essreduce

Common data reduction tools for the ESS facility

- +
essimaging

Neutron imaging data reduction (ODIN, TBL, YMIR)

+ +
essnmx
+

Macromolecular crystallography data reduction (NMX)

+
diff --git a/packages/essimaging/docs/_templates/doc_version.html b/packages/essimaging/docs/_templates/doc_version.html index 06214b3e1..e132409a1 100644 --- a/packages/essimaging/docs/_templates/doc_version.html +++ b/packages/essimaging/docs/_templates/doc_version.html @@ -1,2 +1,2 @@ -Current ESSimaging version: {{ version }} (older versions). +Current ESSimaging version: {{ version }} (older versions). diff --git a/packages/essimaging/docs/about/index.md b/packages/essimaging/docs/about/index.md index 09d5d5842..40e5661b4 100644 --- a/packages/essimaging/docs/about/index.md +++ b/packages/essimaging/docs/about/index.md @@ -18,9 +18,9 @@ To cite a specific version of ESSimaging, select the desired version on Zenodo t ## Older versions of the documentation -Older versions of the documentation pages can be found under the assets of each [release](https://github.com/scipp/essimaging/releases). +Older versions of the documentation pages can be found under the assets of each [release](https://github.com/scipp/ess/releases?q=essimaging). Simply download the archive, unzip and view locally in a web browser. ## Source code and development -ESSimaging is hosted and developed [on GitHub](https://github.com/scipp/essimaging). +ESSimaging is hosted and developed [on GitHub](https://github.com/scipp/ess/tree/main/packages/essimaging). diff --git a/packages/essimaging/docs/conf.py b/packages/essimaging/docs/conf.py index e1f4babe3..585651ac2 100644 --- a/packages/essimaging/docs/conf.py +++ b/packages/essimaging/docs/conf.py @@ -166,7 +166,7 @@ "image_dark": "_static/logo-dark.svg", }, "external_links": [ - {"name": "Essreduce", "url": "https://scipp.github.io/essreduce"}, + {"name": "Essreduce", "url": "https://scipp.github.io/ess/reduce"}, {"name": "Plopp", "url": "https://scipp.github.io/plopp"}, {"name": "Sciline", "url": "https://scipp.github.io/sciline"}, {"name": "Scipp", "url": "https://scipp.github.io"}, @@ -178,7 +178,7 @@ "icon_links": [ { "name": "GitHub", - "url": "https://github.com/scipp/essimaging", + "url": "https://github.com/scipp/ess/tree/main/packages/essimaging", "icon": "fa-brands fa-github", "type": "fontawesome", }, diff --git a/packages/essimaging/docs/index.md b/packages/essimaging/docs/index.md index aff6ae241..a996a292a 100644 --- a/packages/essimaging/docs/index.md +++ b/packages/essimaging/docs/index.md @@ -70,8 +70,8 @@ conda install -c conda-forge essimaging ## Get in touch -- If you have questions that are not answered by these documentation pages, ask on [discussions](https://github.com/scipp/essimaging/discussions). Please include a self-contained reproducible example if possible. -- Report bugs (including unclear, missing, or wrong documentation!), suggest features or view the source code [on GitHub](https://github.com/scipp/essimaging). +- If you have questions that are not answered by these documentation pages, ask on [discussions](https://github.com/scipp/ess/discussions). Please include a self-contained reproducible example if possible. +- Report bugs (including unclear, missing, or wrong documentation!), suggest features or view the source code [on GitHub](https://github.com/scipp/ess/tree/main/packages/essimaging). ```{toctree} --- diff --git a/packages/essimaging/pyproject.toml b/packages/essimaging/pyproject.toml index 7cb97e106..139bc486a 100644 --- a/packages/essimaging/pyproject.toml +++ b/packages/essimaging/pyproject.toml @@ -67,7 +67,7 @@ docs = [ [project.urls] "Bug Tracker" = "https://github.com/scipp/ess/issues" -"Documentation" = "https://scipp.github.io/essimaging" +"Documentation" = "https://scipp.github.io/ess/imaging" "Source" = "https://github.com/scipp/ess/tree/main/packages/essimaging" [tool.setuptools_scm] diff --git a/packages/essnmx/docs/_templates/doc_version.html b/packages/essnmx/docs/_templates/doc_version.html index 64fad2201..c3d7acc82 100644 --- a/packages/essnmx/docs/_templates/doc_version.html +++ b/packages/essnmx/docs/_templates/doc_version.html @@ -1,2 +1,2 @@ -Current ESSnmx version: {{ version }} (older versions). +Current ESSnmx version: {{ version }} (older versions). diff --git a/packages/essnmx/docs/about/data_workflow_overview.md b/packages/essnmx/docs/about/data_workflow_overview.md index 998db4517..e2681f9fa 100644 --- a/packages/essnmx/docs/about/data_workflow_overview.md +++ b/packages/essnmx/docs/about/data_workflow_overview.md @@ -13,7 +13,7 @@ The main scientific driver is to locate the hydrogen atoms relevant to the funct ### From single event data to binned image-like data (scipp) The first step in the data reduction is to reduce the data from single event data to image-like data.
-Therefore the [essNMX](https://github.com/scipp/essnmx) package is used. +Therefore the [essNMX](https://github.com/scipp/ess/tree/main/packages/essnmx) package is used. The time of arrival (TOA) should be converted into time of flight (TOF). diff --git a/packages/essnmx/docs/about/index.md b/packages/essnmx/docs/about/index.md index 61b745dfa..226eeb3a3 100644 --- a/packages/essnmx/docs/about/index.md +++ b/packages/essnmx/docs/about/index.md @@ -26,9 +26,9 @@ To cite a specific version of ESSnmx, select the desired version on Zenodo to ge ## Older versions of the documentation -Older versions of the documentation pages can be found under the assets of each [release](https://github.com/scipp/essnmx/releases). +Older versions of the documentation pages can be found under the assets of each [release](https://github.com/scipp/ess/releases?q=essnmx). Simply download the archive, unzip and view locally in a web browser. ## Source code and development -ESSnmx is hosted and developed [on GitHub](https://github.com/scipp/essnmx). +ESSnmx is hosted and developed [on GitHub](https://github.com/scipp/ess/tree/main/packages/essnmx). diff --git a/packages/essnmx/docs/conf.py b/packages/essnmx/docs/conf.py index b427d470c..26bac64d6 100644 --- a/packages/essnmx/docs/conf.py +++ b/packages/essnmx/docs/conf.py @@ -167,6 +167,7 @@ "image_dark": "_static/logo-dark.svg", }, "external_links": [ + {"name": "Essreduce", "url": "https://scipp.github.io/ess/reduce"}, {"name": "Plopp", "url": "https://scipp.github.io/plopp"}, {"name": "Sciline", "url": "https://scipp.github.io/sciline"}, {"name": "Scipp", "url": "https://scipp.github.io"}, @@ -175,7 +176,7 @@ "icon_links": [ { "name": "GitHub", - "url": "https://github.com/scipp/essnmx", + "url": "https://github.com/scipp/ess/tree/main/packages/essnmx", "icon": "fa-brands fa-github", "type": "fontawesome", }, diff --git a/packages/essnmx/docs/index.md b/packages/essnmx/docs/index.md index 2445e0fd1..6b8b13297 100644 --- a/packages/essnmx/docs/index.md +++ b/packages/essnmx/docs/index.md @@ -34,8 +34,8 @@ ## Get in touch -- If you have questions that are not answered by these documentation pages, ask on [discussions](https://github.com/scipp/essnmx/discussions). Please include a self-contained reproducible example if possible. -- Report bugs (including unclear, missing, or wrong documentation!), suggest features or view the source code [on GitHub](https://github.com/scipp/essnmx). +- If you have questions that are not answered by these documentation pages, ask on [discussions](https://github.com/scipp/ess/discussions). Please include a self-contained reproducible example if possible. +- Report bugs (including unclear, missing, or wrong documentation!), suggest features or view the source code [on GitHub](https://github.com/scipp/ess/tree/main/packages/essnmx). ```{toctree} --- diff --git a/packages/essnmx/pyproject.toml b/packages/essnmx/pyproject.toml index bf3b96d52..143636423 100644 --- a/packages/essnmx/pyproject.toml +++ b/packages/essnmx/pyproject.toml @@ -74,9 +74,9 @@ docs = [ ] [project.urls] -"Bug Tracker" = "https://github.com/scipp/essnmx/issues" -"Documentation" = "https://scipp.github.io/essnmx" -"Source" = "https://github.com/scipp/essnmx" +"Bug Tracker" = "https://github.com/scipp/ess/issues" +"Documentation" = "https://scipp.github.io/ess/nmx" +"Source" = "https://github.com/scipp/ess/tree/main/packages/essnmx" [tool.setuptools_scm] root = "../.." diff --git a/packages/essreduce/docs/_templates/doc_version.html b/packages/essreduce/docs/_templates/doc_version.html index 3f5055a63..3d44096be 100644 --- a/packages/essreduce/docs/_templates/doc_version.html +++ b/packages/essreduce/docs/_templates/doc_version.html @@ -1,2 +1,2 @@ -Current ESSreduce version: {{ version }} (older versions). +Current ESSreduce version: {{ version }} (older versions). diff --git a/packages/essreduce/docs/about/index.md b/packages/essreduce/docs/about/index.md index 07b8078ce..5e33de003 100644 --- a/packages/essreduce/docs/about/index.md +++ b/packages/essreduce/docs/about/index.md @@ -18,9 +18,9 @@ To cite a specific version of ESSreduce, select the desired version on Zenodo to ## Older versions of the documentation -Older versions of the documentation pages can be found under the assets of each [release](https://github.com/scipp/essreduce/releases). +Older versions of the documentation pages can be found under the assets of each [release](https://github.com/scipp/ess/releases?q=essreduce). Simply download the archive, unzip and view locally in a web browser. ## Source code and development -ESSreduce is hosted and developed [on GitHub](https://github.com/scipp/essreduce). +ESSreduce is hosted and developed [on GitHub](https://github.com/scipp/ess/tree/main/packages/essreduce). diff --git a/packages/essreduce/docs/conf.py b/packages/essreduce/docs/conf.py index 198fb8c5c..30f494bbd 100644 --- a/packages/essreduce/docs/conf.py +++ b/packages/essreduce/docs/conf.py @@ -168,8 +168,8 @@ }, "external_links": [ {"name": "ESSdiffraction", "url": "https://scipp.github.io/essdiffraction"}, - {"name": "ESSimaging", "url": "https://scipp.github.io/essimaging"}, - {"name": "ESSnmx", "url": "https://scipp.github.io/essnmx"}, + {"name": "ESSimaging", "url": "https://scipp.github.io/ess/imaging"}, + {"name": "ESSnmx", "url": "https://scipp.github.io/ess/nmx"}, {"name": "ESSpolarization", "url": "https://scipp.github.io/esspolarization"}, {"name": "ESSreflectometry", "url": "https://scipp.github.io/essreflectometry"}, {"name": "ESSsans", "url": "https://scipp.github.io/esssans"}, @@ -178,7 +178,7 @@ "icon_links": [ { "name": "GitHub", - "url": "https://github.com/scipp/essreduce", + "url": "https://github.com/scipp/ess/tree/main/packages/essreduce", "icon": "fa-brands fa-github", "type": "fontawesome", }, diff --git a/packages/essreduce/docs/index.md b/packages/essreduce/docs/index.md index b6fcaf65b..d5e838205 100644 --- a/packages/essreduce/docs/index.md +++ b/packages/essreduce/docs/index.md @@ -34,8 +34,8 @@ ## Get in touch -- If you have questions that are not answered by these documentation pages, ask on [discussions](https://github.com/scipp/essreduce/discussions). Please include a self-contained reproducible example if possible. -- Report bugs (including unclear, missing, or wrong documentation!), suggest features or view the source code [on GitHub](https://github.com/scipp/essreduce). +- If you have questions that are not answered by these documentation pages, ask on [discussions](https://github.com/scipp/ess/discussions). Please include a self-contained reproducible example if possible. +- Report bugs (including unclear, missing, or wrong documentation!), suggest features or view the source code [on GitHub](https://github.com/scipp/ess/tree/main/packages/essreduce). ```{toctree} --- diff --git a/packages/essreduce/pyproject.toml b/packages/essreduce/pyproject.toml index 487f37dd3..374d65426 100644 --- a/packages/essreduce/pyproject.toml +++ b/packages/essreduce/pyproject.toml @@ -70,7 +70,7 @@ grow-nexus = "ess.reduce.scripts.grow_nexus:main" [project.urls] "Bug Tracker" = "https://github.com/scipp/ess/issues" -"Documentation" = "https://scipp.github.io/essreduce" +"Documentation" = "https://scipp.github.io/ess/reduce" "Source" = "https://github.com/scipp/ess/tree/main/packages/essreduce" [tool.setuptools_scm]