summaryrefslogtreecommitdiff
path: root/doc/conf.py
diff options
context:
space:
mode:
authorDanny Holman <dholman@gymli.org>2024-10-18 14:42:13 -0500
committerDanny Holman <dholman@gymli.org>2024-10-18 14:42:13 -0500
commit28e27060274591fe13d5a1a226216fb01141e2f7 (patch)
tree72110e56a4e12a01129fe045227b9e0b5bfa6a28 /doc/conf.py
parent74df10cc9f7ce264ac017b4efac918818f460c25 (diff)
doc: hook documentation into build system
Add a target to the build system that will generate the included documentation. This target should be called "docs" and should only be called explictity, not during the default build target. Signed-off-by: Danny Holman <dholman@gymli.org>
Diffstat (limited to 'doc/conf.py')
-rw-r--r--doc/conf.py28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 0000000..d1b4119
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,28 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Rune Game Engine'
+copyright = '2024, Danny Holman'
+author = 'Danny Holman'
+release = 'v0.61.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['breathe']
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+breathe_default_project = "rune-engine"
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']