Skip to content

Commit 9723983

Browse files
committed
Documentation: Add configuration for Read the Docs
Also, relocate `docs` dependencies to dedicated file.
1 parent 77fff9d commit 9723983

3 files changed

Lines changed: 35 additions & 12 deletions

File tree

.readthedocs.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
4+
# Details
5+
# - https://docs.readthedocs.io/en/stable/config-file/v2.html
6+
7+
# Required
8+
version: 2
9+
10+
build:
11+
os: "ubuntu-24.04"
12+
tools:
13+
python: "3.14"
14+
15+
sphinx:
16+
configuration: docs/conf.py
17+
builder: html
18+
fail_on_warning: true
19+
20+
# Optionally build your docs in additional formats such as PDF
21+
#formats:
22+
# - pdf

docs/requirements.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
furo
2+
myst-parser[linkify]>=0.18,<6
3+
roman-numerals-py<5
4+
sphinx<10
5+
sphinx-autobuild
6+
sphinx-copybutton
7+
sphinx-design-elements<1
8+
sphinx-sitemap<3
9+
sphinxcontrib-mermaid<3
10+
sphinxext-opengraph<1

pyproject.toml

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -139,18 +139,6 @@ optional-dependencies.develop = [
139139
"ruff<0.12",
140140
"validate-pyproject<1",
141141
]
142-
optional-dependencies.docs = [
143-
"furo",
144-
"myst-parser[linkify]>=0.18,<6",
145-
"roman-numerals-py<5",
146-
"sphinx<10",
147-
"sphinx-autobuild",
148-
"sphinx-copybutton",
149-
"sphinx-design-elements<1",
150-
"sphinx-sitemap<3",
151-
"sphinxcontrib-mermaid<3",
152-
"sphinxext-opengraph<1",
153-
]
154142
optional-dependencies.full = [ "omniload[ibm-db,odbc,oracle]" ]
155143
optional-dependencies.ibm-db = [
156144
"ibm-db<4; platform_machine!='aarch64'",
@@ -343,12 +331,15 @@ tasks.check = [
343331
"test",
344332
]
345333
tasks.docs-autobuild = [
334+
{ cmd = "uv pip install -r docs/requirements.txt;" },
346335
{ cmd = "sphinx-autobuild --open-browser docs docs/_build" },
347336
]
348337
tasks.docs-html = [
338+
{ cmd = "uv pip install -r docs/requirements.txt;" },
349339
{ cmd = "sphinx-build -W --keep-going docs docs/_build" },
350340
]
351341
tasks.docs-linkcheck = [
342+
{ cmd = "uv pip install -r docs/requirements.txt;" },
352343
{ cmd = "sphinx-build -W --keep-going -b linkcheck docs docs/_build" },
353344
]
354345
tasks.docs-lint = { cmd = "vale docs --glob='!**/.vitepress/**'" }

0 commit comments

Comments
 (0)