• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# .readthedocs.yaml
2# Read the Docs configuration file
3# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4
5# Required
6version: 2
7
8# Set the version of Python and other tools you might need
9build:
10  os: ubuntu-20.04
11  tools:
12    python: "3.9"
13  jobs:
14    pre_build:
15      - make apidoc
16      - breathe-apidoc -o docs/api apidoc/xml
17
18# Build documentation in the docs/ directory with Sphinx
19sphinx:
20  builder: dirhtml
21  configuration: docs/conf.py
22
23# Optionally declare the Python requirements required to build your docs
24python:
25  install:
26  - requirements: docs/requirements.txt
27