Merge pull request #52 from stuartmaxwell:docs-site

Docs-site

docs/.gitignore

@@ -0,0 +1 @@
+_build

docs/__init__.py

@@ -0,0 +1 @@
+"""Documentation builder for the project."""

docs/conf.py

@@ -0,0 +1,51 @@
+"""Configuration file for the Sphinx documentation builder."""
+
+from pathlib import Path
+
+import tomllib
+
+# Define the path to pyproject.toml
+pyproject_path = Path(__file__).parent.parent / "pyproject.toml"
+
+# Read the version from pyproject.toml
+with pyproject_path.open("rb") as f:
+    pyproject_data = tomllib.load(f)
+    djpress_version = pyproject_data["project"]["version"]
+
+# General information about the project.
+project = "DJ Press"
+copyright = "2024, Stuart Maxwell"  # noqa: A001
+author = "Stuart Maxwell"
+release = djpress_version
+
+# -- General configuration ---------------------------------------------------
+
+extensions = [
+    "myst_parser",
+]
+myst_enable_extensions = ["colon_fence"]
+myst_heading_anchors = 3
+
+templates_path = ["_templates"]
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+]
+
+language = "en"
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "nord"
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {}
+html_title = project
+html_static_path = []

docs/index.md

@@ -1,4 +1,19 @@
-# DJ Press Docs
+# DJ Press Documentation
 
-- [URL structure](url_structure.md)
+Welcome to the documentation site for DJ Press. This is a work in progress, but the following key areas are mostly
+complete:
+
+- [URL Structure](url_structure.md)
 - [Template Tags](templatetags.md)
+- [Themes](themes.md)
+
+## Table of Contents
+
+```{toctree}
+---
+maxdepth: 2
+---
+url_structure
+templatetags
+themes
+```