Skip to content

Commit c17f995

Browse files
authored
Merge pull request #1843 from EliahKagan/rtd-deps
Build online docs (RTD) with -W and dependencies
2 parents d3d177c + 64ad585 commit c17f995

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

Diff for: .readthedocs.yaml

+12-10
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# Required
55
version: 2
66

7-
# Set the OS, Python version and other tools you might need
7+
# Set the OS, Python version and other tools you might need.
88
build:
99
os: ubuntu-22.04
1010
tools:
@@ -14,22 +14,24 @@ build:
1414
# rust: "1.70"
1515
# golang: "1.20"
1616

17-
# Build documentation in the "docs/" directory with Sphinx
17+
# Build documentation in the "doc/" directory with Sphinx.
1818
sphinx:
1919
configuration: doc/source/conf.py
2020
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
2121
# builder: "dirhtml"
2222
# Fail on all warnings to avoid broken references
23-
# fail_on_warning: true
23+
fail_on_warning: true
2424

25-
# Optionally build your docs in additional formats such as PDF and ePub
25+
# Optionally build your docs in additional formats such as PDF and ePub.
2626
# formats:
27-
# - pdf
28-
# - epub
27+
# - pdf
28+
# - epub
2929

3030
# Optional but recommended, declare the Python requirements required
31-
# to build your documentation
31+
# to build your documentation.
3232
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
33-
# python:
34-
# install:
35-
# - requirements: docs/requirements.txt
33+
python:
34+
install:
35+
- method: pip
36+
path: .
37+
- requirements: doc/requirements.txt

Diff for: doc/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
# Options for HTML output
9494
# -----------------------
9595

96-
# html_theme = "sphinx_rtd_theme"
96+
html_theme = "sphinx_rtd_theme"
9797
html_theme_options = {}
9898

9999
# The name for this set of Sphinx documents. If None, it defaults to

0 commit comments

Comments
 (0)