Skip to content

Commit 46924dd

Browse files
committed
Update README.md
1 parent 31a7187 commit 46924dd

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

readme.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,17 @@
22

33
This repo contains the source for the currently WIP version of Project Aeon's online docs.
44

5-
The docs are built via [Sphinx](https://www.sphinx-doc.org/en/master/), and hosted via GitHub Pages at [sainsburywellcomecentre.github.io/aeon_docs/](https://sainsburywellcomecentre.github.io/aeon_docs/). `src/` is the Sphinx source directory, and the site is built and deployed from the `gh-pages` branch. This is handled by a GitHub actions workflow (`.github/workflows/docs_build_and_deploy.yml`). The build job is triggered on each PR, ensuring that the documentation build is not broken by new changes. The deployment job is only triggered whenever a tag is pushed to the main branch.
6-
5+
The docs are built via [Sphinx](https://www.sphinx-doc.org/en/master/), and hosted via GitHub Pages at [sainsburywellcomecentre.github.io/aeon_docs/](https://sainsburywellcomecentre.github.io/aeon_docs/).
6+
`src/` is the Sphinx source directory, and the site is built and deployed from the `gh-pages` branch.
7+
This is handled by a GitHub actions workflow (`.github/workflows/docs_build_and_deploy.yml`), triggered by the following events:
8+
- **Push to the main branch**
9+
- **Tag push**
10+
- **Pull request**
11+
- **Manual dispatch** via the "Run workflow" button in the Actions tab.
12+
13+
The workflow comprises two jobs: `build_sphinx_docs` and `deploy_sphinx_docs`.
14+
The build job is triggered by all the listed events to ensure the documentation build remains intact with new changes.
15+
The deployment job is only triggered on manual dispatch or [when a tag is pushed](#deploying-the-documentation).
716

817
## Building the documentation locally
918
Create a `conda` environment with the required dependencies and activate it:
@@ -70,7 +79,7 @@ linkcheck_allowed_redirects = {
7079
}
7180
```
7281
## Deploying the documentation
73-
As mentioned above, the deployment job is triggered whenever a tag is pushed to the main branch. To deploy the documentation, follow these steps:
82+
As mentioned above, the deployment job can either be triggered manually or by a tag push. To deploy with a tag push, follow the steps below:
7483

7584
Fetch all tags:
7685
```bash

0 commit comments

Comments
 (0)