django-cms · fsbraun · Oct 29, 2025 · Oct 29, 2025
diff --git a/.readthedocs.yaml b/.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
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/Makefile b/docs/Makefile
@@ -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".

diff --git a/docs/pyproject.toml b/docs/pyproject.toml
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -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 ..
diff --git a/docs/_static/.gitkeep → docs/source/_static/.gitkeep b/docs/_static/.gitkeep → docs/source/_static/.gitkeep
diff --git a/docs/changelog.rst → docs/source/changelog.rst b/docs/changelog.rst → docs/source/changelog.rst
diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
@@ -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.

diff --git a/docs/contributing.rst → docs/source/contributing.rst b/docs/contributing.rst → docs/source/contributing.rst
diff --git a/docs/how-to/01-use-multi-site.rst → docs/source/how-to/01-use-multi-site.rst b/docs/how-to/01-use-multi-site.rst → docs/source/how-to/01-use-multi-site.rst
diff --git a/docs/how-to/02-plugin-creation.rst → docs/source/how-to/02-plugin-creation.rst b/docs/how-to/02-plugin-creation.rst → docs/source/how-to/02-plugin-creation.rst
diff --git a/docs/how-to/index.rst → docs/source/how-to/index.rst b/docs/how-to/index.rst → docs/source/how-to/index.rst
diff --git a/docs/index.rst → docs/source/index.rst b/docs/index.rst → docs/source/index.rst
diff --git a/docs/reference/breadcrumbs.rst → docs/source/reference/breadcrumbs.rst b/docs/reference/breadcrumbs.rst → docs/source/reference/breadcrumbs.rst
diff --git a/docs/reference/index.rst → docs/source/reference/index.rst b/docs/reference/index.rst → docs/source/reference/index.rst
diff --git a/docs/reference/languages.rst → docs/source/reference/languages.rst b/docs/reference/languages.rst → docs/source/reference/languages.rst
diff --git a/docs/reference/menu.rst → docs/source/reference/menu.rst b/docs/reference/menu.rst → docs/source/reference/menu.rst
diff --git a/docs/reference/pages.rst → docs/source/reference/pages.rst b/docs/reference/pages.rst → docs/source/reference/pages.rst
diff --git a/docs/reference/placeholders.rst → docs/source/reference/placeholders.rst b/docs/reference/placeholders.rst → docs/source/reference/placeholders.rst
diff --git a/docs/reference/plugins.rst → docs/source/reference/plugins.rst b/docs/reference/plugins.rst → docs/source/reference/plugins.rst
diff --git a/docs/reference/submenu.rst → docs/source/reference/submenu.rst b/docs/reference/submenu.rst → docs/source/reference/submenu.rst
diff --git a/docs/tutorial/01-quickstart.rst → docs/source/tutorial/01-quickstart.rst b/docs/tutorial/01-quickstart.rst → docs/source/tutorial/01-quickstart.rst
diff --git a/docs/tutorial/02-installation.rst → docs/source/tutorial/02-installation.rst b/docs/tutorial/02-installation.rst → docs/source/tutorial/02-installation.rst
diff --git a/docs/tutorial/03-openapi-documentation.rst → ...rce/tutorial/03-openapi-documentation.rst b/docs/tutorial/03-openapi-documentation.rst → ...rce/tutorial/03-openapi-documentation.rst
diff --git a/docs/tutorial/index.rst → docs/source/tutorial/index.rst b/docs/tutorial/index.rst → docs/source/tutorial/index.rst