Skip to content

Commit f9c22e2

Browse files
authored
Update RTD config (#164)
1 parent 6ecc911 commit f9c22e2

File tree

4 files changed

+35
-18
lines changed

4 files changed

+35
-18
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,3 +128,4 @@ dmypy.json
128128
.pyre/
129129
*.rpm
130130
src/subprocess_tee/_version.py
131+
_readthedocs

.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: mkdocs.yml
7+
8+
build:
9+
os: ubuntu-24.04
10+
tools:
11+
python: "3.11"
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

readthedocs.yml

Lines changed: 0 additions & 16 deletions
This file was deleted.

tox.ini

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ min_version = 4.6.3
44
env_list =
55
lint
66
pkg
7+
docs
78
deps
89
py
910
alpine
@@ -69,11 +70,17 @@ allowlist_externals =
6970
docker
7071

7172
[testenv:docs]
72-
description = Build docs
73+
description = Builds docs
74+
package = editable
75+
skip_install = false
7376
extras =
7477
docs
78+
set_env =
79+
DYLD_FALLBACK_LIBRARY_PATH = /opt/homebrew/lib:{env:LD_LIBRARY_PATH}
80+
NO_COLOR = 1
81+
TERM = dump
7582
commands =
76-
mkdocs build --strict
83+
mkdocs {posargs:build --strict --site-dir=_readthedocs/html/}
7784

7885
[testenv:lint]
7986
description = Run all linters

0 commit comments

Comments
 (0)