-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
schema.yml
124 lines (94 loc) · 3.52 KB
/
schema.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# Read the Docs configuration file
# This schema uses https://github.com/23andMe/Yamale
# for the validation.
# Default values are indicated with a comment (``Default: ...``).
# Some values are default to the project config (settings from the web panel).
# The version of the spec to be use
version: enum('2')
# Formats of the documentation to be built
# Default: []
formats: any(list(enum('htmlzip', 'pdf', 'epub')), enum('all'), required=False)
# Configuration for Conda support
conda: include('conda', required=False)
# Configuration for the documentation build process
build: include('build', required=False)
# Configuration of the Python environment to be used
python: include('python', required=False)
# Configuration for sphinx documentation
# Default documentation type
sphinx: include('sphinx', required=False)
# Configuration for mkdocs documentation
mkdocs: include('mkdocs', required=False)
# Submodules configuration
submodules: include('submodules', required=False)
search: include('search', required=False)
# Redirects for the current version to be built
# Key/value list, represent redirects of type `type`
# from url -> to url
# Default: null
redirects: map(enum('page'), map(str(), str()), required=False)
---
conda:
# The path to the Conda environment file from the root of the project
environment: path()
build:
# The build docker image to be used
# Default: 'latest'
# Note: it can be overridden by a project
image: enum('stable', 'latest', required=False)
# List of packages to be installed with apt-get
# Default: []
apt_packages: list(str(), required=False)
python:
# The Python version (this depends on the build image)
# Default: '3'
version: enum('2', '2.7', '3', '3.3', '3.4', '3.5', '3.6', required=False)
# Installation of packages and requirements
install: list(any(include('python-install-requirements'), include('python-install')), required=False)
python-install-requirements:
# The path to the requirements file from the root of the project
requirements: path()
python-install:
# The path to the project to be installed
path: path()
# Install using python setup.py install or pip
# Default: pip
method: enum('pip', 'setuptools', required=False)
# Extra requirements sections to install in addition to the package dependencies.
# Only valid when `method` is `pip`.
# Default: []
extra_requirements: list(str(), required=False)
sphinx:
# The builder type for the sphinx documentation
# Default: 'html'
builder: enum('html', 'htmldir', 'dirhtml', 'singlehtml', required=False)
# The path to the conf.py file
# Default: rtd will try to find it | project config
configuration: path(required=False)
# Add the -W option to sphinx-build
# Default: false
fail_on_warning: bool(required=False)
mkdocs:
# The path to the mkdocs.yml file
# Default: rtd will try to find it
configuration: path(required=False)
# Add the --strict option to mkdocs build
# Default: false
fail_on_warning: bool(required=False)
submodules:
# List of submodules to be included
# Default: []
include: any(list(str()), enum('all'), required=False)
# List of submodules to be ignored
# Default: []
exclude: any(list(str()), enum('all'), required=False)
# Do a recursive clone?
# Default: false
recursive: bool(required=False)
search:
# Map of patterns to ranks
# Default: {}
ranking: map(str(), int(min=-10, max=10), required=False)
# List of patterns
# Default: ['search.html', 'search/index.html', '404.html', '404/index.html']
ignore: list(str(), required=False)