Skip to content

Commit

Permalink
Updated to support Sphinx publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
stuartmaxwell committed Nov 13, 2024
1 parent a8df5a7 commit 8ca622b
Show file tree
Hide file tree
Showing 10 changed files with 952 additions and 148 deletions.
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_build
1 change: 1 addition & 0 deletions docs/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"""Documentation builder for the project."""
51 changes: 51 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -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 = []
19 changes: 17 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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
```
Loading

0 comments on commit 8ca622b

Please sign in to comment.