-
Notifications
You must be signed in to change notification settings - Fork 893
/
.readthedocs.yml
36 lines (31 loc) · 768 Bytes
/
.readthedocs.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
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.9"
nodejs: "19"
jobs:
post_checkout:
- git fetch --unshallow || true
pre_build:
- pip freeze
- python -m sphinx -WETan -j auto -D language=en -b linkcheck -d _build/doctrees docs/source _build/linkcheck
# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
configuration: docs/source/conf.py
fail_on_warning: true
python:
install:
- method: pip
path: .
extra_requirements:
- docs
search:
ranking:
# Push API docs in the /api directory down the ranking
api/*: -5