Skip to content

Commit 6887d6d

Browse files
committed
Add a Read the Docs configuration file; test doc builds
1 parent 3f500ae commit 6887d6d

24 files changed

+217
-656
lines changed

Diff for: .github/workflows/test.yaml

+13
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,16 @@ jobs:
7777
env:
7878
SQLALCHEMY_UTILS_TEST_POSTGRESQL_PASSWORD: postgres
7979
run: tox -e ${{ matrix.tox_env }}
80+
81+
docs:
82+
runs-on: 'ubuntu-latest'
83+
steps:
84+
- uses: actions/checkout@v4
85+
- name: Set up Python
86+
uses: actions/setup-python@v5
87+
with:
88+
python-version: '3.12'
89+
- name: Install tox
90+
run: pip install tox
91+
- name: Build documentation
92+
run: tox -e docs

Diff for: .gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,5 @@ venv/
6161
ENV/
6262
env.bak/
6363
venv.bak/
64+
65+
poetry.lock

Diff for: .readthedocs.yaml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: 2
2+
3+
build:
4+
os: "ubuntu-22.04"
5+
tools:
6+
python: "3.12"
7+
8+
python:
9+
install:
10+
- requirements: "requirements/docs/requirements.txt"
11+
12+
sphinx:
13+
configuration: "docs/conf.py"
14+
fail_on_warning: false

Diff for: CHANGES.rst

+3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Unreleased changes
88

99
- Drop support for Python 3.7 and 3.8.
1010
- Add support for Python 3.12.
11+
- Add a Read the Docs configuration file.
12+
- Make documentation builds reproducible.
13+
- Test documentation builds in CI.
1114

1215
0.41.2 (2024-03-22)
1316
^^^^^^^^^^^^^^^^^^^

Diff for: docs/Makefile

-153
This file was deleted.

0 commit comments

Comments
 (0)