From 4835bf3d33b30c53353e86c1c8139cf4a3a4d466 Mon Sep 17 00:00:00 2001 From: Irmen de Jong Date: Wed, 21 Feb 2024 21:55:22 +0100 Subject: [PATCH] readthedocs --- .readthedocs.yaml | 27 +++++++++++++++++++++++++++ docs/requirements.txt | 3 +++ 2 files changed, 30 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..2ca9a91 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,27 @@ +# .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-22.04 + tools: + python: "3.12" + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: docs/requirements.txt + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/source/conf.py + fail_on_warning: true + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: + - pdf + - epub diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..77e4dcc --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +sphinx>7.0.0 +sphinx_rtd_theme>=1.2 +sphinxcontrib-jquery