Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding readthedocs YAML config file #1612

Merged
merged 1 commit into from
May 30, 2018
Merged

Adding readthedocs YAML config file #1612

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Configuration for readthedocs

# Important: we need to disable all unneeded formats.
# Note that HTML and JSON are always built:
# https://docs.readthedocs.io/en/latest/yaml-config.html#formats
# Especially, the 'htmlzip' format takes a LOT of memory and causes
# the build to fail - see our issue #1472:
# https://github.com/aiidateam/aiida_core/issues/1472
formats: []

## For now I don't specify any other parameter, that is
## currently setup in the web page of Read the Docs.
## For other parameters see
## https://docs.readthedocs.io/en/latest/yaml-config.html