Skip to content

Commit

Permalink
Add a Read the Docs configuration file; test doc builds
Browse files Browse the repository at this point in the history
  • Loading branch information
kurtmckee committed Sep 5, 2024
1 parent 3f500ae commit 6887d6d
Show file tree
Hide file tree
Showing 24 changed files with 217 additions and 656 deletions.
13 changes: 13 additions & 0 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,5 @@ venv/
ENV/
env.bak/
venv.bak/

poetry.lock
14 changes: 14 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
^^^^^^^^^^^^^^^^^^^
Expand Down
153 changes: 0 additions & 153 deletions docs/Makefile

This file was deleted.

Loading

0 comments on commit 6887d6d

Please sign in to comment.