Skip to content

Update old URLs links and update github pages URL schema #334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MridulS merged 1 commit into from
Apr 17, 2026
Merged

Update old URLs links and update github pages URL schema #334

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/workflows/docs-deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 6 additions & 2 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,14 +153,18 @@ <h1>ESS Data Reduction</h1>

<div class="label">Packages</div>
<div class="cards">
<a class="card" href="essreduce/">
<a class="card" href="reduce/">
<div class="card-name">essreduce</div>
<p>Common data reduction tools for the ESS facility</p>
</a>
<a class="card" href="essimaging/">
<a class="card" href="imaging/">
<div class="card-name">essimaging</div>
<p>Neutron imaging data reduction (ODIN, TBL, YMIR)</p>
</a>
<a class="card" href="nmx/">
<div class="card-name">essnmx</div>
<p>Macromolecular crystallography data reduction (NMX)</p>
</a>
</div>
</main>

Expand Down
2 changes: 1 addition & 1 deletion packages/essimaging/docs/_templates/doc_version.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!-- This will display the version of the docs -->
Current ESSimaging version: {{ version }} (<a href="https://github.com/scipp/essimaging/releases">older versions</a>).
Current ESSimaging version: {{ version }} (<a href="https://github.com/scipp/ess/releases?q=essimaging">older versions</a>).
4 changes: 2 additions & 2 deletions packages/essimaging/docs/about/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 2 additions & 2 deletions packages/essimaging/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"},
Expand All @@ -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",
},
Expand Down
4 changes: 2 additions & 2 deletions packages/essimaging/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
---
Expand Down
2 changes: 1 addition & 1 deletion packages/essimaging/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion packages/essnmx/docs/_templates/doc_version.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!-- This will display the version of the docs -->
Current ESSnmx version: {{ version }} (<a href="https://github.com/scipp/essnmx/releases">older versions</a>).
Current ESSnmx version: {{ version }} (<a href="https://github.com/scipp/ess/releases?q=essnmx">older versions</a>).
2 changes: 1 addition & 1 deletion packages/essnmx/docs/about/data_workflow_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. <br>
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).
<!--Not implemented for measurement data-->
Expand Down
4 changes: 2 additions & 2 deletions packages/essnmx/docs/about/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
3 changes: 2 additions & 1 deletion packages/essnmx/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"},
Expand All @@ -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",
},
Expand Down
4 changes: 2 additions & 2 deletions packages/essnmx/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
---
Expand Down
6 changes: 3 additions & 3 deletions packages/essnmx/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "../.."
Expand Down
2 changes: 1 addition & 1 deletion packages/essreduce/docs/_templates/doc_version.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!-- This will display the version of the docs -->
Current ESSreduce version: {{ version }} (<a href="https://github.com/scipp/essreduce/releases">older versions</a>).
Current ESSreduce version: {{ version }} (<a href="https://github.com/scipp/ess/releases?q=essreduce">older versions</a>).
4 changes: 2 additions & 2 deletions packages/essreduce/docs/about/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
6 changes: 3 additions & 3 deletions packages/essreduce/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"},
Expand All @@ -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",
},
Expand Down
4 changes: 2 additions & 2 deletions packages/essreduce/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
---
Expand Down
2 changes: 1 addition & 1 deletion packages/essreduce/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Loading