Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 14 additions & 4 deletions .github/workflows/httomo_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ jobs:
shell: bash -el {0}
steps:
- name: Checkout repository code
uses: actions/checkout@v4
uses: actions/checkout@v5

- name: Setup Python 3.10
uses: actions/setup-python@v4
- name: Setup Python 3.12
uses: actions/setup-python@v5
with:
python-version: '3.10'
python-version: '3.12'

- name: httomo-docs
uses: mamba-org/setup-micromamba@v2
Expand All @@ -40,6 +40,10 @@ jobs:
run: |
python ./docs/source/scripts/execute_pipelines_build.py -o ./docs/source/pipelines_full/

- name: Create ZIP archive for pipelines
run: |
zip -r pipelines_full_artifact.zip ./docs/source/pipelines_full/

- name: Build docs
run: sphinx-build -a -E -b html ./docs/source/ ./docs/build/

Expand All @@ -48,3 +52,9 @@ jobs:
run: ghp-import -n -p -f ./docs/build
env:
GITHUB_TOKEN: ${{ github.token }}

- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: full_pipelines-artifact
path: pipelines_full_artifact.zip
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository code
uses: actions/checkout@v4
uses: actions/checkout@v5
- name: Run black
uses: psf/black@stable
30 changes: 14 additions & 16 deletions docs/source/backends/templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,12 @@ Here you can find either fixed (archived) templates that were previously release
If you installed HTTomo with a specific version associated with the release, please use the :ref:`archived_templates`. If you are a developer, or
you need to access the latest developments, please use the :ref:`latest_templates`.

.. _archived_templates:

Archived Templates
===================

These are archived YAML templates that can be used with already released and tagged version of HTTomo.

.. only:: builder_html

:download:`HTTomo version 2.5 templates <../templates_archive/httomo_ver2_5_yaml_templates.zip>`

:download:`HTTomo version 2.6 templates <../templates_archive/httomo_ver2_6_yaml_templates.zip>`

:download:`HTTomo version 3.0 templates <../templates_archive/httomo_ver3_0_yaml_templates.zip>`

.. _latest_templates:

Latest Templates
================

The templates below are generated for the current/latest HTTomo development. These templates can be updated frequently and
The templates below are generated for the **current/latest** HTTomo development. These templates can be updated frequently and
if you need to use templates that are linked to a specific released (tagged) HTTomo version, please see the archives above.

.. note:: At DLS, the templates bellow should work with the :code:`httomo/latest` module.
Expand All @@ -39,3 +24,16 @@ if you need to use templates that are linked to a specific released (tagged) HTT
`HTTomolib Modules <https://diamondlightsource.github.io/httomo-backends/backends/templates.html#httomolib-modules>`_

`TomoPy Modules <https://diamondlightsource.github.io/httomo-backends/backends/templates.html#tomopy-modules>`_

.. _archived_templates:

Archived Templates
===================

These are archived YAML templates that can be used with already released and tagged version of HTTomo.

.. only:: builder_html

:download:`HTTomo version 2.6 templates <../templates_archive/httomo_ver2_6_yaml_templates.zip>`

:download:`HTTomo version 3.0 templates <../templates_archive/httomo_ver3_0_yaml_templates.zip>`
2 changes: 0 additions & 2 deletions docs/source/pipelines/yaml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ These are archived full YAML pipelines that can be used with already released an

.. only:: builder_html

:download:`HTTomo version 2.5 full YAML pipelines <../templates_archive/httomo_ver2_5_full_yaml_pipelines.zip>`

:download:`HTTomo version 2.6 full YAML pipelines <../templates_archive/httomo_ver2_6_full_yaml_pipelines.zip>`

:download:`HTTomo version 3.0 full YAML pipelines <../templates_archive/httomo_ver3_0_full_yaml_pipelines.zip>`
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ dev-gpu = [
"mypy",
"types-PyYAML",
"pre-commit",
"ccpi-regularisation-cupy",
]

[tool.mypy]
Expand Down
Loading