From 5499395e4c261e94b5aa3cb6f6c13d6246a70618 Mon Sep 17 00:00:00 2001 From: Daniel Oliveira Date: Mon, 26 Aug 2024 06:05:11 -0400 Subject: [PATCH] feat(readthedocs): create configuration file Signed-off-by: Daniel Oliveira Signed-off-by: David Cerdeira --- .readthedocs.yaml | 34 ++++++++++++++++++++++++++++++++++ source/requirements.txt | 3 +++ 2 files changed, 37 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 source/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..dbb19de --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,34 @@ +# .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 OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + install: + - requirements: source/requirements.txt + # You can also specify other tool versions: + # nodejs: "19" + # rust: "1.64" + # golang: "1.19" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: source/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 diff --git a/source/requirements.txt b/source/requirements.txt new file mode 100644 index 0000000..4c77341 --- /dev/null +++ b/source/requirements.txt @@ -0,0 +1,3 @@ +sphinx +sphinxcontrib-spelling +sphinx-tabs