Skip to content

Commit

Permalink
docs: enable RTD builds (#4258)
Browse files Browse the repository at this point in the history
  • Loading branch information
dboddie committed Jul 7, 2023
1 parent 36cc6f7 commit 4d0d751
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
---
# Required
version: 2

build:
os: ubuntu-20.04
tools:
python: "3.8"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
builder: html
fail_on_warning: true

# Build documentation with MkDocs
# mkdocs:
# configuration: mkdocs.yml

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

# Optionally set the version of Python
# and requirements required to build your docs
python:
install:
- requirements: docs/.sphinx/requirements.txt

0 comments on commit 4d0d751

Please sign in to comment.