Skip to content

Commit c7359d8

Browse files
committed
update cross-refs
1 parent 25ddd75 commit c7359d8

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

.github/workflows/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GitHub Actions
22

3-
There is a single github action file with multiple jobs, which builds both the conda package and documentation, and optionally publishes the documentation: [build](https://github.com/TomographicImaging/CIL/blob/master/.github/workflows/build.yml)
3+
There is a single github action file with multiple jobs, which builds both the conda package and documentation, and optionally publishes the documentation: [build](./build.yml)
44

55
The jobs are:
66

@@ -29,7 +29,7 @@ When opening or modifying a pull request to `master`, a single variant is built
2929
> The action does not publish to conda, instead this is done by jenkins. We will eventually move from jenkins to conda-forge instead.
3030
> When pushing to `master` or creating an [annotated tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging), *all* variants are built and tested.
3131
32-
It looks for conda-build dependencies in the channels listed [here](https://github.com/TomographicImaging/CIL/blob/master/.github/workflows/build.yml#L118). If you add any new dependencies, the appropriate channels need to be added to this line.
32+
It looks for conda-build dependencies in the channels listed [here](./build.yml#L118). If you add any new dependencies, the appropriate channels need to be added to this line.
3333

3434
> [!TIP]
3535
> The `conda` job builds the `*.tar.bz2` package and uploads it as an artifact called `cil-package`.
@@ -38,11 +38,11 @@ It looks for conda-build dependencies in the channels listed [here](https://gith
3838
3939
## docs
4040

41-
This github action builds and optionally publishes the documentation located in [docs/source](https://github.com/TomographicImaging/CIL/tree/master/docs/source). To do this it uses a forked version of the [build-sphinx-action](https://github.com/lauramurgatroyd/build-sphinx-action).
41+
This github action builds and optionally publishes the documentation located in [docs/source](../../docs/source).
4242

43-
The [docs](https://github.com/TomographicImaging/CIL/blob/master/.github/workflows/build.yml#L124) job:
43+
The [docs](./build.yml#L124) job:
4444

45-
- creates a `miniconda` environment from [requirements-test.yml](https://github.com/TomographicImaging/CIL/blob/master/scripts/requirements-test.yml) and [docs_environment.yml](https://github.com/TomographicImaging/CIL/blob/master/docs/docs_environment.yml)
45+
- creates a `miniconda` environment from [requirements-test.yml](../../scripts/requirements-test.yml) and [docs_environment.yml](../../docs/docs_environment.yml)
4646
- `cmake` builds & installs CIL into the `miniconda` environment
4747
- builds the HTML documentation with `sphinx`
4848
- uploads a `DocumentationHTML` artifact (which can be downloaded to view locally for debugging)

0 commit comments

Comments
 (0)