Sphinx docs stub

Author: cjw296

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= uv run sphinx-build
+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,25 @@
+from importlib import metadata
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+]
+
+intersphinx_mapping = {
+    'python': ('http://docs.python.org', None),
+}
+
+project = 'pytest-sqlalchemy'
+author = 'Torsten Irländer'
+release = metadata.version(project)
+copyright = f'2015 onwards {author}'
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+autodoc_member_order = 'bysource'
+
+html_theme = 'furo'
+
+nitpicky = True
+nitpick_ignore: list[tuple[str, str]] = []

docs/index.rst

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

pyproject.toml

@@ -32,6 +32,10 @@ dev = [
     "mypy>=1.15.0",
     "pytest-xdist>=3.6.1",
 ]
+docs = [
+    "furo>=2024.8.6",
+    "sphinx>=8.1.3",
+]
 
 [build-system]
 requires = ["setuptools>=61.0"]