From cfe4d7c146f33d6b1d91b16173907a66e15720e6 Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Tue, 3 May 2022 14:12:02 +0300 Subject: [PATCH] docs: add the readthedocs configuration We need to install additional plantuml package before the build Fixes: https://pagure.io/freeipa/issue/9148 Signed-off-by: Alexander Bokovoy Reviewed-By: Francisco Trivino --- .readthedocs.yaml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..3be35438a --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,30 @@ +# .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.8" + apt_packages: + - plantuml + - graphviz + - fonts-ipafont + - fonts-ipaexfont + +# Build documentation in the doc/ directory with Sphinx +sphinx: + configuration: doc/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +# formats: +# - pdf + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: doc/requirements.txt