From 83f3b7f9fa0706727d7a960e0e89dab10d3fe185 Mon Sep 17 00:00:00 2001 From: Iustin Pop Date: Sat, 6 Jan 2024 22:46:58 +0100 Subject: [PATCH] Add readthedocs config file to restore doc builds --- .readthedocs.yaml | 38 ++++++++++++++++++++++++++++++++++++++ doc/requirements.txt | 1 + 2 files changed, 39 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 doc/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..2297bb7 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,38 @@ +# Read the Docs configuration file for Sphinx projects +# 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.12" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + jobs: + pre_build: + - make posix1e.so + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: doc/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# 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: doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..02bf565 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1 @@ +recommonmark -- 2.39.5