Skip to content

Commit

Permalink
Merge pull request #1843 from EliahKagan/rtd-deps
Browse files Browse the repository at this point in the history
Build online docs (RTD) with -W and dependencies
  • Loading branch information
Byron authored Feb 24, 2024
2 parents d3d177c + 64ad585 commit c17f995
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 11 deletions.
22 changes: 12 additions & 10 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Required
version: 2

# Set the OS, Python version and other tools you might need
# Set the OS, Python version and other tools you might need.
build:
os: ubuntu-22.04
tools:
Expand All @@ -14,22 +14,24 @@ build:
# rust: "1.70"
# golang: "1.20"

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

# Optionally build your docs in additional formats such as PDF and ePub
# Optionally build your docs in additional formats such as PDF and ePub.
# formats:
# - pdf
# - epub
# - pdf
# - epub

# Optional but recommended, declare the Python requirements required
# to build your documentation
# to build your documentation.
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt
python:
install:
- method: pip
path: .
- requirements: doc/requirements.txt
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
# Options for HTML output
# -----------------------

# html_theme = "sphinx_rtd_theme"
html_theme = "sphinx_rtd_theme"
html_theme_options = {}

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

0 comments on commit c17f995

Please sign in to comment.