From fb9ba023b5d0e50e45bae7a4dc68979a92c11d3f Mon Sep 17 00:00:00 2001 From: Eteimz <8teims@gmail.com> Date: Fri, 2 May 2025 02:01:14 +0100 Subject: [PATCH] Added requirements file --- .readthedocs.yaml | 23 +++++++++++++++++++++++ docs/source/conf.py | 1 + docs/source/requirements.txt | 4 ++++ 3 files changed, 28 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs/source/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..b3012a2 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,23 @@ +# 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-24.04 + tools: + python: "3.11" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# Optionally, 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/source/requirements.txt + diff --git a/docs/source/conf.py b/docs/source/conf.py index fff04d9..f370900 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -20,6 +20,7 @@ extensions = [ "sphinx.ext.autodoc", + "sphinx_copybutton" ] templates_path = ['_templates'] diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt new file mode 100644 index 0000000..eca7476 --- /dev/null +++ b/docs/source/requirements.txt @@ -0,0 +1,4 @@ +furo +sphinx +sphinx-autobuild +sphinx-copybutton