readthedocs.yml 760 Bytes
Newer Older
BO ZHANG's avatar
BO ZHANG committed
1
2
3
4
5
6
7
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

8
build:
9
  os: ubuntu-22.04
10
11
  tools:
    python: "3.9"
12
    nodejs: "16"
13

BO ZHANG's avatar
BO ZHANG committed
14
15
16
17
18
19
20
# Build documentation in the docs/ directory with Sphinx
sphinx:
  builder: html
  configuration: doc/source/conf.py
  fail_on_warning: true

# Optionally build your docs in additional formats such as PDF
21
22
23
formats:
  - pdf
  - htmlzip
BO ZHANG's avatar
BO ZHANG committed
24
25
26
27

# Optionally set the version of Python and requirements required to build your docs
python:
  install:
28
    - requirements: doc/requirements.txt
BO ZHANG's avatar
BO ZHANG committed
29
30
31
32
33
34
35
36
37
38
39
40
    - method: pip
      path: .

submodules:
  include: []
  recursive: False

search:
  ranking:
    api/v1/*: -1
    api/v2/*: 4
  ignore:
41
    - 404.html