readthedocs.org/.readthedocs.yml at main · readthedocs/readthedocs.org · GitHub

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
version: 2

formats:
  - epub
  - htmlzip

sphinx:
  configuration: docs/conf.py
  fail_on_warning: true

python:
  install:
    - requirements: requirements/docs.txt

build:
  os: ubuntu-22.04
  tools:
    python: "3.12"

search:
  ranking:
    # Deprecated content
    api/v1.html: -1
    config-file/v1.html: -5

    # Surface the tutorial content first, this page covers the configuration
    # file basics very well. The explanation page is more conceptual and about
    # versioning. Bump up the v2 reference page a little too, but the tutorial
    # should be the first page the user looks at still.
    config-file/index.html: 5
    config-file/v2.html: 2
    explanation/configuration-file.html: -1

    # Useful content, but not something we want most users finding
    changelog.html: -6
  ignore:
    - dmca/archive/*