Merge pull request #750 from kurtmckee/docs

Test doc builds; add a RTD config file

.github/workflows/test.yaml

@@ -77,3 +77,16 @@ jobs:
         env:
           SQLALCHEMY_UTILS_TEST_POSTGRESQL_PASSWORD: postgres
         run: tox -e ${{ matrix.tox_env }}
+
+  docs:
+    runs-on: 'ubuntu-latest'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Install tox
+        run: pip install tox
+      - name: Build documentation
+        run: tox -e docs

.gitignore

@@ -61,3 +61,5 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+
+poetry.lock

.readthedocs.yaml

@@ -0,0 +1,14 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - requirements: "requirements/docs/requirements.txt"
+
+sphinx:
+  configuration: "docs/conf.py"
+  fail_on_warning: false

CHANGES.rst

@@ -8,6 +8,9 @@ Unreleased changes
 
 - Drop support for Python 3.7 and 3.8.
 - Add support for Python 3.12.
+- Add a Read the Docs configuration file.
+- Make documentation builds reproducible.
+- Test documentation builds in CI.
 
 0.41.2 (2024-03-22)
 ^^^^^^^^^^^^^^^^^^^