Skip to content

Commit 20512b7

Browse files
MtkN1Kriechi
authored andcommitted
Fix Read the Docs build
1 parent 2abd24c commit 20512b7

File tree

4 files changed

+38
-2
lines changed

4 files changed

+38
-2
lines changed

.readthedocs.yaml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the OS, Python version and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.11"
13+
# You can also specify other tool versions:
14+
# nodejs: "19"
15+
# rust: "1.64"
16+
# golang: "1.19"
17+
18+
# Build documentation in the "docs/" directory with Sphinx
19+
sphinx:
20+
configuration: docs/source/conf.py
21+
22+
# Optionally build your docs in additional formats such as PDF and ePub
23+
# formats:
24+
# - pdf
25+
# - epub
26+
27+
# Optional but recommended, declare the Python requirements required
28+
# to build your documentation
29+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
30+
python:
31+
install:
32+
- requirements: docs/source/requirements.txt
33+
- method: pip
34+
path: .

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
# The theme to use for HTML and HTML Help pages. See the documentation for
6565
# a list of builtin themes.
6666
#
67-
html_theme = 'default'
67+
html_theme = 'sphinx_rtd_theme'
6868

6969
# Add any paths that contain custom static files (such as style sheets) here,
7070
# relative to this directory. They are copied after the builtin static files,

docs/source/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
sphinx
2+
sphinx-rtd-theme

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ commands =
3939

4040
[testenv:docs]
4141
deps =
42-
sphinx
42+
-r docs/source/requirements.txt
4343
allowlist_externals = make
4444
changedir = {toxinidir}/docs
4545
commands =

0 commit comments

Comments
 (0)