Skip to content

Commit

Permalink
docs: configure RTD using config file
Browse files Browse the repository at this point in the history
This gives us more visibility into the RTD settings, rather than the
settings being only visible to the account owning the docs (lukehsiao).

In addition, this treats warnings and errors so we can catch PR
documentation issues early. See #515.
  • Loading branch information
lukehsiao committed Sep 24, 2020
1 parent 81b6270 commit 9fdab80
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

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

formats:
- pdf
- epub

build:
image: latest

python:
version: 3.7
instal:
- requirements: docs/requirements.txt

0 comments on commit 9fdab80

Please sign in to comment.