feat: Add readthedocs support

Author: fsbraun

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+sphinx:
+  configuration: docs/source/conf.py
+  fail_on_warning: false
+
+formats:
+  - epub
+  - pdf
+
+python:
+  install:
+    - requirements: docs/requirements.txt

docs/.gitignore

@@ -5,7 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
+SOURCEDIR     = source/
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".

docs/Makefile

@@ -0,0 +1,9 @@
+# Generated from docs/pyproject.toml [tool.poetry.dependencies]
+# Note: Poetry caret constraints (^) converted to pip-compatible specifiers
+sphinx>=7.2.6,<8.0.0
+sphinx-rtd-theme>=2.0.0,<3.0.0
+sphinx-autodoc-typehints>=2.0.0,<3.0.0
+sphinx-copybutton>=0.5.2,<0.6.0
+sphinx-tabs>=3.4.4,<4.0.0
+furo>=2025.7.19,<2026.0.0
+-e ..

docs/pyproject.toml

@@ -13,6 +13,8 @@
 import os
 import sys
 
+from djangocms_rest import __version__
+
 sys.path.insert(0, os.path.abspath(".."))
 
 # -- Project information -----------------------------------------------------
@@ -22,7 +24,8 @@
 author = "Django CMS Association and contributors"
 
 # The full version, including alpha/beta/rc tags
-release = "0.1.0"
+
+release = __version__
 
 # -- General configuration ---------------------------------------------------
 
@@ -121,10 +124,10 @@
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-html_title = "djangocms-rest"
+html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-html_short_title = "djangocms-rest"
+# html_short_title = "djangocms-rest"
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.