aboutsummaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@ost.ch>2026-08-20 16:04:48 +0200
committerFelix Morgner <felix.morgner@ost.ch>2026-08-20 16:04:48 +0200
commit5117ee7b57f7e349d35c88d31b0d3714a2afbcc6 (patch)
tree12d2bae0dbfa74ed6f9161952f134ea1c520b15a /docs/conf.py
parent51bd0daba2fa3cd42242b2c07cf4851bc7845fb1 (diff)
downloadkernel-5117ee7b57f7e349d35c88d31b0d3714a2afbcc6.tar.xz
kernel-5117ee7b57f7e349d35c88d31b0d3714a2afbcc6.zip
docs: draft new documentation structure
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 47863a06..1712f2a7 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -13,7 +13,10 @@ author = "Felix Morgner"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-extensions = ["breathe"]
+extensions = [
+ "sphinx.ext.todo",
+ "breathe",
+]
templates_path = ["_templates"]
exclude_patterns = ["pre/**"]
@@ -25,6 +28,11 @@ breathe_projects = {"kernel": "../build/doxygen/xml"}
breathe_default_project = "kernel"
breathe_default_members = ('members', 'undoc-members', 'protected-members', 'private-members')
+# -- Options todo ---------------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html
+
+todo_include_todos = True
+
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output