Skip to content

Commit fba86f8

Browse files
committed
Wire Sphinx builds into the RTD config via tox
Resolves #917
1 parent 69540bf commit fba86f8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+64
-71
lines changed

.readthedocs.yaml

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,33 @@
1-
---
2-
# Read the Docs configuration file for Sphinx projects
1+
# Read the Docs configuration file
32
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
---
44

55
version: 2
6+
67
build:
7-
os: ubuntu-22.04
8+
os: ubuntu-24.04
89
tools:
9-
python: '3.12'
10-
11-
sphinx:
12-
configuration: docs/source/conf.py
13-
fail_on_warning: true
10+
python: >- # has to be parsed as a YAML string
11+
3.12
12+
commands:
13+
- >-
14+
PYTHONWARNINGS=error
15+
python3 -Im venv "${READTHEDOCS_VIRTUALENV_PATH}"
16+
- >-
17+
PYTHONWARNINGS=error
18+
"${READTHEDOCS_VIRTUALENV_PATH}"/bin/python -Im
19+
pip install tox
20+
- >-
21+
PYTHONWARNINGS=error
22+
"${READTHEDOCS_VIRTUALENV_PATH}"/bin/python -Im
23+
tox -e docs --notest -vvvvv
24+
- >-
25+
PYTHONWARNINGS=error
26+
"${READTHEDOCS_VIRTUALENV_PATH}"/bin/python -Im
27+
tox -e docs --skip-pkg-install -q
28+
--
29+
"${READTHEDOCS_OUTPUT}"/html
30+
-b html
31+
-D language=en
1432
15-
python:
16-
install:
17-
- requirements: dependencies/default/constraints.txt
18-
- requirements: dependencies/docs/constraints.txt
19-
- path: .
33+
...

docs/Makefile

Lines changed: 0 additions & 20 deletions
This file was deleted.
File renamed without changes.

0 commit comments

Comments
 (0)