summaryrefslogtreecommitdiffstats
path: root/.readthedocs.yml
blob: bb33e2e92d44b46e8aa4039d912fa4039869ac59 (plain)
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
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html
# for details

---

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
  builder: html
  configuration: docs/conf.py
  fail_on_warning: true

# Build documentation with MkDocs
#mkdocs:
#  configuration: mkdocs.yml
#  fail_on_warning: true

# Optionally build your docs in additional formats
# such as PDF and ePub
formats: []

submodules:
  include: all  # []
  exclude: []
  recursive: true

build:
  image: latest

# Optionally set the version of Python and requirements required
# to build docs
python:
  version: 3.8
  install:
  - method: pip
    path: .
  - requirements: docs/requirements.txt
  system_packages: false