Skip to content

Commit

Permalink
RTD: Add configuration file
Browse files Browse the repository at this point in the history
  • Loading branch information
akien-mga committed Aug 11, 2020
1 parent e1db0dd commit 9d90333
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
27 changes: 27 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

build:
image: latest

sphinx:
configuration: docs/conf.py

# Possible options: htmlzip, pdf, epub
# All disabled for now:
# - single-page htmlzip is too big to be usable, and requires too much memory.
# - pdf generates too many latex warnings and the build is killed once logs
# reach 4 MB. Could likely be improved if someone is motivated.
# - epub is too big, and has tons of validation errors which make most readers
# treat it as invalid (GH-3862). Also, it's ugly.
# Hopefully one day we'll have a multi-page HTML zip option, but until
# then, all offline download options are worthless.
# (Track https://github.com/readthedocs/readthedocs.org/issues/3242)
formats: []

python:
install:
- requirements: docs/requirements.txt
2 changes: 1 addition & 1 deletion docs
Submodule docs updated 1 files
+12 −1 .readthedocs.yml

0 comments on commit 9d90333

Please sign in to comment.