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 diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 2eb66e7..bd8e38e 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -19,11 +19,14 @@ master Added ~~~~~ + +- (`#12 `_) Added workflow for ensuring that the docs can be built - (`#15 `_) Fix packaging issues and add installation instructions - (`#6 `_) Added example run notebooks and tests thereof - (`#1 `_) Added :func:`climate_assessment.cli.run_workflow` + v0.1.0 - 2022-06-08 -------------------