Merge pull request sigmavirus24#1158 from sigmavirus24/ci/auto-upload-docs

sigmavirus24 · web-flow · commit 03d4bc5a3f52 · 2023-12-15T08:43:34.000-06:00
Add docs upload workflow
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,45 @@
+---
+name: Check documentation
+
+"on":
+  schedule:
+    - cron: "0 1 * * *" # everyday at 1am
+  push:
+    paths:
+      - "**.rst"
+      - "docs/**"
+  pull_request:
+    paths:
+      - "**.rst"
+      - "docs/**"
+
+jobs:
+  docs:
+    name: Build documentation & check links
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Upgrade pip
+        run: |
+          pip install -U pip
+          pip --version
+
+      - name: Install Tox
+        run: |
+          pip install tox
+          tox --version
+
+      - name: Build documentation
+        run: tox
+        env:
+          TOXENV: docs
+
+      - name: Upload documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: docs/build
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,12 @@
+version: 2
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+sphinx:
+  configuration: docs/source/conf.py
+formats: all
+python:
+  install:
+    - requirements: docs/source/requirements.txt
+    - path: .
