-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy path.readthedocs.yml
41 lines (32 loc) · 944 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
37
38
39
40
41
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.9"
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
fail_on_warning: true
# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml
# Optionally build your docs in additional formats such as PDF
formats:
- htmlzip
# Optionally set the version of Python and requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
# Optionally rank topics in search results, between -10 (lower) and 10 (higher).
# 0 is normal rank, not no rank
search:
ranking:
cms-installation.html: 3
run-simulations.html: 2
configuration-file.html: 2
solvers.html: 2