|
1 |
| -# .readthedocs.yaml |
2 |
| -# Read the Docs configuration file |
| 1 | +# Copyright (c) 2019 Uber Technologies, Inc. |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | +# ============================================================================== |
| 15 | +# |
| 16 | +# ReadTheDocs.io build configuration: supply addition pip install options |
3 | 17 | # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
4 |
| - |
5 |
| -# Required |
| 18 | +# |
6 | 19 | version: 2
|
7 | 20 |
|
8 | 21 | # Build documentation in the docs/ directory with Sphinx
|
9 | 22 | sphinx:
|
10 |
| - configuration: docs/conf.py |
| 23 | + configuration: docs/conf.py |
| 24 | + fail_on_warning: true |
11 | 25 |
|
12 |
| -# Optionally build your docs in additional formats such as PDF |
| 26 | +# Don't build any extra formats |
13 | 27 | formats: []
|
14 | 28 |
|
15 |
| -# Optionally set the version of Python and requirements required to build your docs |
| 29 | +# Requirements for building docs |
16 | 30 | python:
|
17 |
| - version: 3.7 |
18 |
| - install: |
19 |
| - - requirements: docs/requirements.txt |
| 31 | + version: 3.7 |
| 32 | + install: |
| 33 | + - requirements: docs/requirements.txt |
0 commit comments