aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py31
-rw-r--r--docs/index.rst13
2 files changed, 44 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 = []
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..44e7617
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,13 @@
+Welcome to TeachOS Kernel's documentation!
+==========================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`