Skip to content

Commit

Permalink
CI: split docs into separate GitHub Action (#1660)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkralidis committed May 17, 2024
1 parent 6c31a8e commit 01e1b6b
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 4 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Build documentation ⚙️

on:
push:
branches:
- master
paths:
- 'docs/**'
pull_request:
branches:
- master
paths:
- 'docs/**'
release:
types:
- released

jobs:
main:
runs-on: ubuntu-22.04
strategy:
matrix:
include:
- python-version: '3.10'
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
name: Setup Python ${{ matrix.python-version }}
with:
python-version: ${{ matrix.python-version }}
- name: Install requirements 📦
run: |
pip3 install -r requirements.txt
pip3 install -r docs/requirements.txt
- name: build docs 🏗️
run: cd docs && make html
5 changes: 2 additions & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ on:
push:
paths-ignore:
- '**.md'
- 'docs/**'
pull_request:
branches:
- master
paths-ignore:
- '!**.md'
- 'docs/**'
release:
types:
- released
Expand Down Expand Up @@ -90,7 +92,6 @@ jobs:
pip3 install -r requirements-dev.txt
pip3 install -r requirements-provider.txt
pip3 install -r requirements-django.txt
pip3 install -r docs/requirements.txt
python3 setup.py install
pip3 install --upgrade numpy elasticsearch
pip3 install --upgrade numpy "sqlalchemy<2"
Expand Down Expand Up @@ -139,8 +140,6 @@ jobs:
pytest tests/test_util.py
pytest tests/test_xarray_netcdf_provider.py
pytest tests/test_xarray_zarr_provider.py
- name: build docs 🏗️
run: cd docs && make html
- name: failed tests 🚩
if: ${{ failure() }}
run: |
Expand Down
1 change: 0 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ reference documentation on all aspects of the project.
support
further-reading
license

api-documentation

Indices and tables
Expand Down

0 comments on commit 01e1b6b

Please sign in to comment.