Add .readthedocs.yml file to disable htmlzip and epub builds

Reference: https://docs.readthedocs.io/en/latest/yaml-config.html

`htmlzip` target is too heavy and slows down build a lot (or makes it timeout),
so disabling for now. We could reenable it if an option is given for a non
`singlehtml` target, see https://github.com/rtfd/readthedocs.org/issues/4190.

Also disabling `epub` target for now, as it also makes builds slower and we
iterate too fast on the master branch for it to be meaningful.
We could eventually build ePub versions manually once a month or so and upload
those somewhere if there's demand for it.
This commit is contained in:
Rémi Verschelde 2018-06-06 10:21:25 +02:00
parent 28d09cf550
commit ae7277c1e4
1 changed files with 11 additions and 0 deletions

11
.readthedocs.yml Normal file
View File

@ -0,0 +1,11 @@
# Reference: https://docs.readthedocs.io/en/latest/yaml-config.html
build:
image: latest
# Possible options: htmlzip, pdf, epub
# Disable (single) htmlzip as it's way too big to be useful,
# and leads to excessive memory usage on build
# Disable epub for now to speed up builds
formats:
- pdf