From ac782a33532f52fb705f86f61f525de38d67ff5b Mon Sep 17 00:00:00 2001
From: Oscar Benjamin <oscar.j.benjamin@gmail.com>
Date: Thu, 29 Aug 2024 22:13:21 +0100
Subject: [PATCH] Add readthedocs config file

---
 .readthedocs.yaml    | 34 ++++++++++++++++++++++++++++++++++
 doc/conf.py          | 14 ++++++++++++++
 requirements-dev.txt |  1 +
 3 files changed, 49 insertions(+)
 create mode 100644 .readthedocs.yaml
 create mode 100644 doc/conf.py

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 00000000..fe0156b8
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,34 @@
+# .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 OS, Python version and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+  apt_packages:
+    - libflint-dev
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# 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:
+    - sphinx
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 00000000..92eb91a4
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,14 @@
+"""Sphinx configuration."""
+
+from datetime import datetime
+
+project = "python-Flint"
+author = "Fredrik Johansson"
+copyright = f"{datetime.now().year}, {author}"
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx_rtd_theme",
+]
+#autodoc_typehints = "description"
+html_theme = "sphinx_rtd_theme"
diff --git a/requirements-dev.txt b/requirements-dev.txt
index 1429700e..139a5017 100644
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@@ -6,3 +6,4 @@ meson-python
 pytest
 coverage
 pytest-cov
+sphinx