Skip to content

Commit 53ad188

Browse files
authored
Add RTD config (#183)
1 parent 2a7a5ee commit 53ad188

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

.readthedocs.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
version: 2
3+
4+
mkdocs:
5+
fail_on_warning: true
6+
configuration: docs/source/conf.py
7+
8+
build:
9+
os: ubuntu-24.04
10+
tools:
11+
python: "3.12"
12+
commands:
13+
- pip install --user tox
14+
- python3 -m tox -e docs
15+
python:
16+
install:
17+
- method: pip
18+
path: tox
19+
- method: pip
20+
path: .
21+
extra_requirements:
22+
- docs
23+
submodules:
24+
include: all
25+
recursive: true

tox.ini

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ pass_env =
3030
PYTHONIOENCODING
3131
PYTHONPYCACHEPREFIX
3232
PY_COLORS
33+
READTHEDOCS_OUTPUT
3334
REQUESTS_CA_BUNDLE
3435
RTD_TOKEN
3536
SETUPTOOLS_SCM_DEBUG
@@ -70,7 +71,7 @@ deps =
7071
-r{tox_root}/doc/requirements.txt
7172
commands =
7273
python -m doc8 -e .rst doc CONTRIBUTING.rst README.rst
73-
sphinx-build -W -b html doc/source doc/build/html
74+
sphinx-build -W -b html doc/source {env:READTHEDOCS_OUTPUT:doc/build}/html
7475

7576
[testenv:packaging]
7677
description =

0 commit comments

Comments
 (0)