From d18a76a42c428bd9ffea0c735d5806a651822fb4 Mon Sep 17 00:00:00 2001 From: Janos Tolgyesi Date: Tue, 1 Aug 2023 17:16:30 +0200 Subject: [PATCH] Add readthedocs integration --- .readthedocs.yaml | 32 ++++++++++++++++++++++++++++++++ requirements_dev.txt | 3 +++ 2 files changed, 35 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..cd8f08b --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,32 @@ +# .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.10" + # 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: 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: requirements_dev.txt diff --git a/requirements_dev.txt b/requirements_dev.txt index 718b37b..792bdeb 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -19,3 +19,6 @@ mypy-boto3-dynamodb # Sphinx theme sphinx-rtd-theme + +# Project requirements +boto3~=1.28.10