aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorLuc Van Oostenryck <luc.vanoostenryck@gmail.com>2024-01-04 23:08:36 +0100
committerLuc Van Oostenryck <luc.vanoostenryck@gmail.com>2024-01-07 13:28:43 +0100
commit04558f85973cea64651638e4e5d4e547b3bf421d (patch)
tree52174522364d79ff255c7e2e989fef3b543e8583
parent550130d252e71c5b5552f81b69734f6f10ae6448 (diff)
downloadsparse-04558f85973cea64651638e4e5d4e547b3bf421d.tar.gz
add .readthedocs.yaml
Read the Docs now requires a config file in the project top directory. So, here it is. Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
-rw-r--r--.readthedocs.yaml31
-rw-r--r--Documentation/requirements.txt1
2 files changed, 32 insertions, 0 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 00000000..69f8f403
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,31 @@
+# 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.11"
+
+# Build documentation in the "Documentation/" directory with Sphinx
+sphinx:
+ configuration: Documentation/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: Documentation/requirements.txt
diff --git a/Documentation/requirements.txt b/Documentation/requirements.txt
new file mode 100644
index 00000000..02bf5657
--- /dev/null
+++ b/Documentation/requirements.txt
@@ -0,0 +1 @@
+recommonmark