Skip to content

Commit

Permalink
Merge pull request #933 from Yelp/u/jfong/fix_rtd
Browse files Browse the repository at this point in the history
TRON-2035: Fix public docs w/ new RTDv2 config
  • Loading branch information
jfongatyelp committed Dec 12, 2023
2 parents 425b32f + 5f481d1 commit e12890b
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# RTD defaults as of 2023-11-08
build:
# TODO: Bump to jammy+3.8 once master branch updated
os: ubuntu-20.04
tools:
python: "3.6"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Also provide downloadable zip
formats: [htmlzip]

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/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

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

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: requirements-docs.txt

0 comments on commit e12890b

Please sign in to comment.