From 4d2f0d8b39124f6325ab692694ecaa3f416cc661 Mon Sep 17 00:00:00 2001 From: Edoardo Zoni Date: Tue, 7 Jan 2025 14:04:54 -0800 Subject: [PATCH] ReadTheDocs Config Add config files for ReadTheDocs.org --- .readthedocs.yaml | 25 +++++++++++++++++++++++++ requirements.txt | 1 + 2 files changed, 26 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..07edda4 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,25 @@ +# 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.13" + + commands: + # Write down your commands here to: + # + # - Install the dependencies of your project + # - Build the documentation + # - Save the generated files in $READTHEDOCS_OUTPUT/html + +# 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: requirements.txt diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..fb187da --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +mystmd