AMAROC-847 ampycloud release v2.1 #243
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Copyright (c) 2020-2023 MeteoSwiss, created by F.P.A. Vogt; [email protected] | |
name: CI_docs_check | |
on: | |
# Executed also on push to Master in the odd even that the docs is modified straight from there. | |
push: | |
branches: [ master ] | |
pull_request: | |
branches: [ master, develop, develop_vof ] | |
jobs: | |
docs: | |
runs-on: ${{ matrix.os }} | |
strategy: | |
matrix: | |
os: [ubuntu-latest] | |
python-version: ['3.11'] | |
steps: | |
# Checkout our repository | |
- name: Checkout current repository | |
uses: actions/checkout@v4 | |
# Set up Python | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ matrix.python-version }} | |
# Install any dependency we require for the docs | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
shell: bash | |
# Here, let's install our module to make sure all the dependencies specified in setup.py are | |
# also installed | |
- name: Install our module | |
run: pip install -e .[dev] | |
shell: bash | |
# Launch a home-made python script to compile and check the docs. | |
- name: Compile the docs and look for errors/warnings | |
run: | | |
cd ./docs | |
python ../.github/workflows/docs_check.py | |
shell: bash |