Add a config file for readthedocs

Signed-off-by: Aurélien Bompard <[email protected]>

.readthedocs.yml

@@ -0,0 +1,28 @@
+---
+# 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"
+
+# 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:
+  - htmlzip
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

pyproject.toml

@@ -39,20 +39,23 @@ flask = "^2.0.0 || ^3.0.0"
 authlib = "^1.2.0"
 requests = "^2.24.0"
 blinker = "^1.5.0"
+sphinx = {version = "*", optional = true}
+myst-parser = {version = "*", optional = true}
+sphinxcontrib-httpdomain = {version = "*", optional = true}
+flask-sphinx-themes = {version = "*", optional = true}
 
 [tool.poetry.group.dev.dependencies]
 black = ">=22.6.0"
 pytest = "^7.1.2 || ^8.0.0"
 pytest-cov = ">=3.0.0"
 ruff = ">=0.0.253"
-sphinx = ">=6.1.3"
 responses = ">=0.23.3"
-sphinxcontrib-httpdomain = "^1.8.1"
-flask-sphinx-themes = "^1.0.2"
 packaging = "^23.1"
-myst-parser = "^2.0.0 || ^3.0.0"
 reuse = "^2.1.0 || ^3.0.0"
 
+[tool.poetry.extras]
+docs = ["sphinx", "myst-parser", "sphinxcontrib-httpdomain", "flask-sphinx-themes"]
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"