Skip to content

Commit

Permalink
unify GA and local doc build (#247)
Browse files Browse the repository at this point in the history
  • Loading branch information
yaswant authored Sep 16, 2024
1 parent 8f0b64f commit ba83e6a
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 14 deletions.
15 changes: 6 additions & 9 deletions .github/workflows/publish_wps.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
pull_request:
types: [opened,reopened,review_requested]
workflow_dispatch:

jobs:
build-and-deploy:
runs-on: ubuntu-latest
Expand All @@ -22,23 +22,20 @@ jobs:
- uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install Sphinx packages
- name: Install Dependencies
run: |
pip install Sphinx==6.2.1
pip install sphinx-design==0.5.0
pip install pydata-sphinx-theme
pip install sphinx-sitemap
pip install -r .github/workflows/requirements.txt
- name: build docs
run: |
make clean html
- name: commit docs to gh-pages branch
if: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
run: |
git worktree add ../publish_wps
cd ../publish_wps
git fetch origin gh-pages
git fetch origin gh-pages
git checkout gh-pages
cp -r ../simulation-systems/build/html/. .
git add .
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Sphinx==6.2.1
sphinx-design==0.5.0
pydata-sphinx-theme
sphinx-sitemap
8 changes: 4 additions & 4 deletions env.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: sphinx_doc_env
dependencies:
- Sphinx==6.2.1
- sphinx-design==0.5.0
- pydata-sphinx-theme
- sphinx-sitemap
- python>=3
- pip
- pip:
- -r .github/workflows/requirements.txt
2 changes: 1 addition & 1 deletion source/WorkingPractices/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ commands, noting that ``--jules-path`` is only required if you have
:ref:`guidance<shared-namelists>`.

+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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]`` |
| 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]`` |
+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| JULES | ``./bin/upgrade_jules_test_apps vnX.X_tXXXX`` |
+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down

0 comments on commit ba83e6a

Please sign in to comment.