From 4a1d8fb08a8158de322c7a01c8fab9cd868a4418 Mon Sep 17 00:00:00 2001 From: Dominik Date: Wed, 16 Nov 2022 17:54:28 -0800 Subject: [PATCH] redthedocs conf --- .readthedocs.yaml | 31 +++++++++++++++++++++++++++++++ docs/requirements.txt | 5 +++++ 2 files changed, 36 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..6fe012c --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,31 @@ +# .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 version of Python and other tools you might need +build: + os: ubuntu-20.04 + tools: + python: "3.10" + # You can also specify other tool versions: + # nodejs: "16" + # rust: "1.55" + # golang: "1.17" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +# formats: +# - pdf + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: docs/requirements.txt + - method: pip + path: . diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..3a7a8ca --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +sphinxcontrib-autoprogram +sphinx-mdinclude +m2r2 +nbsphinx +furo