From bcb8041467a1bd2c342c9de444227e8b35a20c24 Mon Sep 17 00:00:00 2001 From: Philip Hackstock Date: Tue, 21 Jun 2022 16:36:13 +0200 Subject: [PATCH 1/2] Add check if the docs build without errors --- .github/workflows/build-docs.yaml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/workflows/build-docs.yaml diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml new file mode 100644 index 0000000..722cd67 --- /dev/null +++ b/.github/workflows/build-docs.yaml @@ -0,0 +1,30 @@ + +# This workflow installs the package and builds the docs +# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions + +name: build the docs + +on: + push: + branches: [ 'main' ] + pull_request: + branches: [ '**' ] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.10' + + - name: Install dependencies and package for building the docs + run: pip install .[docs] + + - name: Build the docs + run: make --directory=doc html From f5d667eb67be4439247d6bbb465bc1b99f1fd07e Mon Sep 17 00:00:00 2001 From: Philip Hackstock Date: Tue, 21 Jun 2022 16:45:03 +0200 Subject: [PATCH 2/2] Add changelog entry --- CHANGELOG.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index f82c499..85ae379 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -19,8 +19,10 @@ master Added ~~~~~ - -- (`#1 `_) Added :func:`climate_assessment.cli.run_workflow` +- (`#12 `_) Added workflow for + ensuring that the docs can be built +- (`#1 `_) Added + :func:`climate_assessment.cli.run_workflow` v0.1.0 - 2022-06-08