Skip to content

Commit 165ed00

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

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

.github/workflows/python_sphinx_docs.yml

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ 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 from master branch of opm-common if we are on master
2323
run: |
2424
curl -L -o python/docstrings_common.json https://raw.githubusercontent.com/OPM/opm-common/master/python/docstrings_common.json
2525
- name: Get docstrings_common.json from master branch of opm-simulators
@@ -44,18 +44,16 @@ jobs:
4444
mkdir gh-pages
4545
touch gh-pages/.nojekyll
4646
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-
47+
# To add a new relase to this build system:
48+
# - add the respective branch <your-new-release> on this repository
49+
# - take a snapshot of https://raw.githubusercontent.com/OPM/opm-common/<your-new-release>/python/docstrings_common.json and
50+
# https://raw.githubusercontent.com/OPM/opm-simulators/<your-new-release>/python/docstrings_simulators.json and put them
51+
# in the python folder on that branch
52+
# - add the respective branch <your-new-release> in the commands below
5553
if [ "${{ github.ref_name }}" == "master" ]; then
5654
poetry run sphinx-versioned -m master -b "master" --force --git-root ../../
5755
else
58-
poetry run sphinx-versioned -m master -b "master ${{ github.ref_name }}" --force --git-root ../../
56+
poetry run sphinx-versioned -m master -b "${{ github.ref_name }} master" --force --git-root ../../
5957
fi
6058
- name: Copy documentation to gh-pages
6159
run: |

0 commit comments

Comments
 (0)