aboutsummaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@ost.ch>2023-10-12 15:10:23 +0200
committerFelix Morgner <felix.morgner@ost.ch>2023-10-12 15:10:23 +0200
commit0db25b0e76151c43a235ae627cf318b69745c2fb (patch)
treeed402c867bd9e3ba4d6b078fbd5f34850a169a59 /docs/conf.py
parent557643b786e1de7a8a391f998130913cb30a242f (diff)
downloadteachos-0db25b0e76151c43a235ae627cf318b69745c2fb.tar.xz
teachos-0db25b0e76151c43a235ae627cf318b69745c2fb.zip
docs: enable sphinx HTML build
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..90ed3dc
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,31 @@
+# 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 = "TeachOS Kernel"
+copyright = "2023, Felix Morgner"
+author = "Felix Morgner"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["breathe"]
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+# -- Options Breathe ---------------------------------------------------------
+# https://breathe.readthedocs.io/en/stable/directives.html#config-values
+
+breathe_projects = {"kernel": "../build/doxygen/xml"}
+breathe_default_project = "kernel"
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_book_theme"
+html_static_path = []