Add docs

.gitignore

@@ -24,3 +24,4 @@
 /.vscode
 yarn-error.log
 *.map
+build

.readthedocs.yaml

@@ -0,0 +1,17 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/conf.py
+# python:
+#   install:
+#     - requirements: docs/requirements.txt
+#     - method: pip
+#       path: .

CHANGELOG.rst

@@ -5,6 +5,7 @@ Next version
 ~~~~~~~~~~~~
 
 - Made the link button only active when the cursor is inside a link.
+- Added docs on read the docs.
 
 
 0.7 (2024-08-02)

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = test
+SOURCEDIR     = .
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,67 @@
+import os
+import re
+import subprocess
+import sys
+
+
+sys.path.append(os.path.abspath(".."))
+
+project = "django-prose-editor"
+author = "Matthias Kestenholz"
+copyright = "2024, " + author
+version = __import__("django_prose_editor").version
+release = subprocess.check_output(
+    "git fetch --tags; git describe --always --tags",
+    shell=True,
+    text=True,
+).strip()
+language = "en"
+
+#######################################
+project_slug = re.sub(r"[^a-z]+", "", project)
+
+extensions = []
+templates_path = ["_templates"]
+source_suffix = ".rst"
+master_doc = "index"
+
+exclude_patterns = ["build", "Thumbs.db", ".DS_Store"]
+pygments_style = "sphinx"
+todo_include_todos = False
+
+html_theme = "alabaster"
+# html_static_path = ["_static"]
+htmlhelp_basename = project_slug + "doc"
+
+latex_elements = {
+    "papersize": "a4",
+}
+latex_documents = [
+    (
+        master_doc,
+        project_slug + ".tex",
+        project + " Documentation",
+        author,
+        "manual",
+    )
+]
+man_pages = [
+    (
+        master_doc,
+        project_slug,
+        project + " Documentation",
+        [author],
+        1,
+    )
+]
+texinfo_documents = [
+    (
+        master_doc,
+        project_slug,
+        project + " Documentation",
+        author,
+        project_slug,
+        "",  # Description
+        "Miscellaneous",
+    )
+]

docs/index.rst

@@ -0,0 +1,2 @@
+.. include:: ../README.rst
+.. include:: ../CHANGELOG.rst

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=.
+set BUILDDIR=build
+set SPHINXPROJ=test
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

pyproject.toml

@@ -44,6 +44,8 @@ optional-dependencies.tests = [
   "coverage",
   "nh3",
 ]
+urls.Documentation = "https://django-prose-editor.readthedocs.io/"
+
 urls.Homepage = "https://github.com/matthiask/django-prose-editor/"
 
 [tool.hatch.build]

tox.ini

@@ -12,3 +12,11 @@ deps =
     dj42: Django>=4.2,<5.0
     dj50: Django>=5.0,<5.1
     djmain: https://github.com/django/django/archive/main.tar.gz
+
+[testenv:docs]
+deps =
+    Sphinx
+changedir = docs
+commands = make html
+skip_install = true
+allowlist_externals = make