Skip to content

Commit b18a85b

Browse files
committed
Fix ReadTheDocs build
Add .readthedocs.yaml, move conf.py into the standard location, install sphinx_rtd_theme, and enable the sphinx_rtd_theme extension.
1 parent e0fd34d commit b18a85b

File tree

3 files changed

+34
-1
lines changed

3 files changed

+34
-1
lines changed

.readthedocs.yaml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
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 version of Python and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.10"
13+
# You can also specify other tool versions:
14+
# nodejs: "16"
15+
# rust: "1.55"
16+
# golang: "1.17"
17+
18+
# Build documentation in the docs/ directory with Sphinx
19+
sphinx:
20+
configuration: docs/conf.py
21+
22+
# If using Sphinx, optionally build your docs in additional formats such as PDF
23+
# formats:
24+
# - pdf
25+
26+
# Optionally declare the Python requirements required to build your docs
27+
python:
28+
install:
29+
- requirements: docs/requirements.txt
30+
- method: pip
31+
path: .
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
# -- General configuration ---------------------------------------------------
88

99
extensions = [
10-
'sphinx.ext.autodoc'
10+
'sphinx.ext.autodoc',
11+
'sphinx_rtd_theme'
1112
]
1213

1314
templates_path = ['_templates']

docs/requirements.txt

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

0 commit comments

Comments
 (0)