From 53f57a81b834b3153fa5b50fd2b78c407be2c3fd Mon Sep 17 00:00:00 2001
From: James Briggs <james.briggs@hotmail.com>
Date: Fri, 30 Aug 2024 17:52:43 +0200
Subject: [PATCH] feat: add docs workflow file
---
.github/workflows/docs.yml | 40 ++++++++++++++++++++++++++++++++++++++
1 file changed, 40 insertions(+)
create mode 100644 .github/workflows/docs.yml
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 00000000..a1d8ddfc
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,40 @@
+name: Docs
+
+on:
+ pull_request:
+
+jobs:
+ build-docs:
+ name: Build Docs
+ runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ python-version:
+ - "3.11"
+ env:
+ POETRY_VERSION: "1.8.3"
+ steps:
+ - uses: actions/checkout@v3
+ - name: Cache Poetry
+ uses: actions/cache@v2
+ with:
+ path: ~/.poetry
+ key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}
+ restore-keys: |
+ ${{ runner.os }}-poetry-
+ - name: Install poetry
+ run: |
+ pipx install poetry==$POETRY_VERSION
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v4
+ with:
+ python-version: ${{ matrix.python-version }}
+ cache: poetry
+ - name: Install dependencies
+ run: |
+ poetry install
+ cd docs
+ pip install -r source/requirements.txt
+ - name: Build docs
+ run: |
+ sphinx-build -M html source build
\ No newline at end of file
--
GitLab