2022-08-08 00:26:40 +00:00
|
|
|
---
|
2022-04-18 18:53:28 +00:00
|
|
|
# .readthedocs.yaml
|
|
|
|
# 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
|
|
|
|
build:
|
|
|
|
os: ubuntu-20.04
|
|
|
|
tools:
|
2022-10-30 02:14:16 +00:00
|
|
|
python: "3.10"
|
2022-04-28 22:06:55 +00:00
|
|
|
|
|
|
|
## apt packages required packages to run cmake on sunshine, note that additional packages are required
|
|
|
|
# apt_packages:
|
|
|
|
# - cmake
|
|
|
|
# - ffmpeg
|
|
|
|
# - libboost-filesystem-dev
|
|
|
|
# - libboost-log-dev
|
|
|
|
# - libboost-thread-dev
|
|
|
|
|
|
|
|
## run cmake
|
|
|
|
# jobs:
|
|
|
|
# pre_build:
|
|
|
|
# - cmake .
|
|
|
|
|
|
|
|
## Include the submodules, required for cmake
|
2022-08-08 00:26:40 +00:00
|
|
|
# submodules:
|
|
|
|
# include: all
|
|
|
|
# recursive: true
|
2022-04-18 18:53:28 +00:00
|
|
|
|
|
|
|
# Build documentation in the docs/ directory with Sphinx
|
|
|
|
sphinx:
|
|
|
|
builder: html
|
|
|
|
configuration: docs/source/conf.py
|
|
|
|
fail_on_warning: true
|
|
|
|
|
|
|
|
# Using Sphinx, build docs in additional formats
|
|
|
|
formats: all
|
|
|
|
|
|
|
|
python:
|
|
|
|
install:
|
2022-10-30 02:14:16 +00:00
|
|
|
- requirements: ./docs/requirements.txt
|
2022-04-18 18:53:28 +00:00
|
|
|
system_packages: true
|