Add configuration for Read The Docs
Signed-off-by: David Horstmann <david.horstmann@arm.com>
This commit is contained in:
parent
7cedefe2fb
commit
bd2947684c
1 changed files with 26 additions and 0 deletions
26
.readthedocs.yaml
Normal file
26
.readthedocs.yaml
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
# .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 and other tools you might need
|
||||||
|
build:
|
||||||
|
os: ubuntu-20.04
|
||||||
|
tools:
|
||||||
|
python: "3.9"
|
||||||
|
jobs:
|
||||||
|
pre_build:
|
||||||
|
- make apidoc
|
||||||
|
- breathe-apidoc -o docs/api apidoc/xml
|
||||||
|
|
||||||
|
# Build documentation in the docs/ directory with Sphinx
|
||||||
|
sphinx:
|
||||||
|
builder: dirhtml
|
||||||
|
configuration: docs/conf.py
|
||||||
|
|
||||||
|
# Optionally declare the Python requirements required to build your docs
|
||||||
|
python:
|
||||||
|
install:
|
||||||
|
- requirements: docs/requirements.txt
|
Loading…
Reference in a new issue