From dc2972b5db1712dfe5be31fdc721abfc3dc02630 Mon Sep 17 00:00:00 2001 From: Andrew Grimberg Date: Fri, 21 Jul 2023 05:58:54 -0700 Subject: [PATCH] CI: Add RTD configuration file RTD will soon be requiring a configuration file for builds. Additionally, they will soon stop honoring the unshallow feature flag that they have on the repository and to get an unshallow checkout we must do so via the config file Issue: RELENG-4815 Signed-off-by: Andrew Grimberg Change-Id: I41ae572570dcfb1b82a8457a5f008cb736ca3c0b --- .readthedocs.yml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..a49ea6e5 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,30 @@ +# 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: + configuration: docs/conf.py + +# Build documentation with MkDocs +#mkdocs: +# configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF +formats: + - pdf + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + jobs: + post_checkout: + - git fetch --unshallow || true + +python: + install: + - requirements: requirements-docs.txt + - {path: ., method: pip} -- 2.16.6