Skip to content

Commit ba83e6a

Browse files
authored
unify GA and local doc build (#247)
1 parent 8f0b64f commit ba83e6a

File tree

4 files changed

+15
-14
lines changed

4 files changed

+15
-14
lines changed

.github/workflows/publish_wps.yml

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
pull_request:
88
types: [opened,reopened,review_requested]
99
workflow_dispatch:
10-
10+
1111
jobs:
1212
build-and-deploy:
1313
runs-on: ubuntu-latest
@@ -22,23 +22,20 @@ jobs:
2222
- uses: actions/setup-python@v5
2323
with:
2424
python-version: '3.x'
25-
- name: Install Sphinx packages
25+
- name: Install Dependencies
2626
run: |
27-
pip install Sphinx==6.2.1
28-
pip install sphinx-design==0.5.0
29-
pip install pydata-sphinx-theme
30-
pip install sphinx-sitemap
31-
27+
pip install -r .github/workflows/requirements.txt
28+
3229
- name: build docs
3330
run: |
3431
make clean html
35-
32+
3633
- name: commit docs to gh-pages branch
3734
if: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
3835
run: |
3936
git worktree add ../publish_wps
4037
cd ../publish_wps
41-
git fetch origin gh-pages
38+
git fetch origin gh-pages
4239
git checkout gh-pages
4340
cp -r ../simulation-systems/build/html/. .
4441
git add .

.github/workflows/requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Sphinx==6.2.1
2+
sphinx-design==0.5.0
3+
pydata-sphinx-theme
4+
sphinx-sitemap

env.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: sphinx_doc_env
22
dependencies:
3-
- Sphinx==6.2.1
4-
- sphinx-design==0.5.0
5-
- pydata-sphinx-theme
6-
- sphinx-sitemap
3+
- python>=3
4+
- pip
5+
- pip:
6+
- -r .github/workflows/requirements.txt

source/WorkingPractices/testing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ commands, noting that ``--jules-path`` is only required if you have
7575
:ref:`guidance<shared-namelists>`.
7676

7777
+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
78-
| UM | ``./admin/rose-stem/update_all.py --path=/path/to/working/copy/of/test/branch --um=vnX.X_tXXXX [--jules-path=/path/to/jules/working/copy/of/branch]`` |
78+
| UM | ``./admin/rose-stem/update_all.py --path=/path/to/working/copy/of/test/branch --um=vnX.X_tXXXX [--jules-path=/path/to/jules/working/copy/of/branch]`` |
7979
+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8080
| JULES | ``./bin/upgrade_jules_test_apps vnX.X_tXXXX`` |
8181
+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

0 commit comments

Comments
 (0)