From 41a28a86b526d40b0fb9cf7c7817bfab2ffd5013 Mon Sep 17 00:00:00 2001 From: Matthew Watkins Date: Wed, 13 Mar 2024 14:49:55 +0000 Subject: [PATCH] Fix: Add RTD docs build configuration file Also, exclude node_modules directory from linting tools Issue: RELENG-5212 Change-Id: I73d2880bac202da76e411f636bdde3cbef1c974b Signed-off-by: Matthew Watkins --- .gitignore | 1 + .readthedocs.yaml | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.gitignore b/.gitignore index 1b37311..933b98b 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ docs/_build/ cloud-env.json *.pyc *.retry +node_modules/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..136a922 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,27 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.10" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +formats: + - pdf + - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt