From 2b5514a94441b9b65abaf7596b8d47308a97f8de Mon Sep 17 00:00:00 2001 From: Dave Page Date: Fri, 23 Sep 2022 12:44:02 +0100 Subject: [PATCH] Add an action to check the doc build (#5363) --- .github/workflows/check-doc-build.yml | 36 +++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 .github/workflows/check-doc-build.yml diff --git a/.github/workflows/check-doc-build.yml b/.github/workflows/check-doc-build.yml new file mode 100644 index 000000000..ac1a08aa5 --- /dev/null +++ b/.github/workflows/check-doc-build.yml @@ -0,0 +1,36 @@ +name: Check documentation build + +on: + # Triggers the workflow on push or pull request events but only for the "master" branch + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v3 + + # Run the tests + - name: Install dependencies + run: sudo apt install build-essential python3-dev libpq-dev libffi-dev libssl-dev libkrb5-dev zlib1g-dev + + - name: Install requirements + run: pip install -r requirements.txt + + - name: Install sphinx + run: pip install sphinx + + - name: Check the documentation + run: make docs