Skip to content

Commit 915dbf0

Browse files
author
Lisa Julia Nebel
committed
Change workflow to build for 2025.04 as well
1 parent 4a22cf9 commit 915dbf0

File tree

1 file changed

+10
-15
lines changed

1 file changed

+10
-15
lines changed

.github/workflows/python_sphinx_docs.yml

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,10 @@ jobs:
1919
uses: actions/checkout@v4
2020
with:
2121
fetch-depth: 0 # Fetch all history for all tags and branches
22-
- name: Get docstrings_common.json from master branch of opm-common
22+
- name: Get docstrings_common.json, docstrings_simulators.json and dune.module from master branches of opm-common and opm-simulators
2323
run: |
2424
curl -L -o python/docstrings_common.json https://raw.githubusercontent.com/OPM/opm-common/master/python/docstrings_common.json
25-
- name: Get docstrings_common.json from master branch of opm-simulators
26-
run: |
2725
curl -L -o python/docstrings_simulators.json https://raw.githubusercontent.com/OPM/opm-simulators/master/python/docstrings_simulators.json
28-
- name: Get dune.module from master branch of opm-simulators, this is needed for the call to extract_opm_simulators_release in python/sphinx_docs/docs/conf.py.
29-
run: |
3026
curl -L -o dune.module https://raw.githubusercontent.com/OPM/opm-simulators/master/dune.module
3127
- name: Set up Python
3228
uses: actions/setup-python@v5
@@ -44,18 +40,17 @@ jobs:
4440
mkdir gh-pages
4541
touch gh-pages/.nojekyll
4642
cd sphinx_docs
47-
# Currently we build only docs for the HEAD of the master branch
48-
# Later we can add release tags to the list to get the docs for the releases
49-
# For example: -b "master, release/2024.04/final" will build the docs for
50-
# the master branch and the release/2024.04/final tag
51-
# For the releases, we create snapshots of the docstrings_common.json and docstrings_simulators.json
52-
# and take the ones tracked by git, only for the master, we take the current ones we fetched
53-
# in steps 2 and 3 of this workflow
54-
43+
# To add a new relase to this build system:
44+
# - add the respective branch <your-new-release> on this repository
45+
# - take a snapshot of https://raw.githubusercontent.com/OPM/opm-common/<your-new-release>/python/docstrings_common.json,
46+
# https://raw.githubusercontent.com/OPM/opm-simulators/<your-new-release>/python/docstrings_simulators.json and
47+
# https://raw.githubusercontent.com/OPM/opm-simulators/<your-new-release>/dune.module and put them
48+
# in the python folder on that branch
49+
# - add the respective branch <your-new-release> in the commands below
5550
if [ "${{ github.ref_name }}" == "master" ]; then
56-
poetry run sphinx-versioned -m master -b "master" --force --git-root ../../
51+
poetry run sphinx-versioned -m master -b "master release/2025.04" --force --git-root ../../
5752
else
58-
poetry run sphinx-versioned -m master -b "master ${{ github.ref_name }}" --force --git-root ../../
53+
poetry run sphinx-versioned -m master -b "${{ github.ref_name }} master release/2025.04" --force --git-root ../../
5954
fi
6055
- name: Copy documentation to gh-pages
6156
run: |

0 commit comments

Comments
 (0)