docs: prepare for pages deployment

17 files changed, 3 insertions, 220 deletions

diff --git a/docs/conf.py b/docs/conf.py
index 1712f2a7..37838427 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,19 +15,11 @@ author = "Felix Morgner"
 
 extensions = [
     "sphinx.ext.todo",
-    "breathe",
 ]
 
 templates_path = ["_templates"]
 exclude_patterns = ["pre/**"]
 
-# -- Options Breathe ---------------------------------------------------------
-# https://breathe.readthedocs.io/en/stable/directives.html#config-values
-
-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
 
@@ -36,5 +28,5 @@ todo_include_todos = True
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "sphinx_book_theme"
+html_theme = "haiku"
 html_static_path = []
diff --git a/docs/index.rst b/docs/index.rst
index b0a4b2c9..f3af6e4f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,13 +1,11 @@
-Welcome to TeachOS Kernel's documentation!
-==========================================
+TeachOS Kernel Developer Documentation
+======================================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    briefs
-   kapi
-   kernel
 
 Indices and tables
 ==================
diff --git a/docs/kapi.rst b/docs/kapi.rst
deleted file mode 100644
index 4c60ab39..00000000
--- a/docs/kapi.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-Kernel API
-==========
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Contents:
-   :glob:
-
-   kapi/*
-
diff --git a/docs/kapi/capabilities.rst b/docs/kapi/capabilities.rst
deleted file mode 100644
index a4d7d999..00000000
--- a/docs/kapi/capabilities.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-Capability Dispatch
-===================
-
-.. todo::
-    Document the facet based capability dispatch mechanism.
-
-API Reference
--------------
-
-Classes
--------
-
-.. doxygenstruct:: kapi::capabilities::facet_id
\ No newline at end of file
diff --git a/docs/kapi/cio.rst b/docs/kapi/cio.rst
deleted file mode 100644
index 15b322fa..00000000
--- a/docs/kapi/cio.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-Character I/O Interface
-=======================
-
-The character I/O interface defines a simple API allowing the kernel to write characters to a platform's output device.
-
-API Reference
--------------
-
-Functions
----------
-
-.. doxygenfunction:: kapi::cio::init
-.. doxygenfunction:: kapi::cio::set_output_device
-.. doxygenfunction:: kapi::cio::write
-
-Classes
--------
-
-.. doxygenstruct:: kapi::cio::output_device
-
-Enums
------
-
-.. doxygenenum:: kapi::cio::output_stream
diff --git a/docs/kapi/cpu.rst b/docs/kapi/cpu.rst
deleted file mode 100644
index ab5d182f..00000000
--- a/docs/kapi/cpu.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-CPU Interface
-=============
-
-.. todo::
-    Write an introduction to the CPU interface.
-
-Functions
----------
-
-.. doxygenfunction:: kapi::cpu::dispatch
-.. doxygenfunction:: kapi::cpu::halt
-.. doxygenfunction:: kapi::cpu::init
-.. doxygenfunction:: kapi::cpu::current_id
-
-Classes
--------
-
-.. doxygenstruct:: kapi::cpu::exception
-.. doxygenstruct:: kapi::cpu::id
-
-Constants
----------
-
-.. doxygenvariable:: kapi::cpu::invalid_id
\ No newline at end of file
diff --git a/docs/kapi/devices.rst b/docs/kapi/devices.rst
deleted file mode 100644
index 8b674e6e..00000000
--- a/docs/kapi/devices.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-Device Interface
-================
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Contents:
-   :glob:
-
-   devices/*
-
-API Reference
--------------
-
-.. doxygenfunction:: kapi::devices::init
-.. doxygenfunction:: kapi::devices::get_root_bus
-.. doxygenfunction:: kapi::devices::remove_device
-.. doxygenfunction:: kapi::devices::publish_facet(kstd::shared_ptr<device>, kstd::string)
-.. doxygenfunction:: kapi::devices::publish_facet(kstd::shared_ptr<device>, kstd::string, Facet *)
-.. doxygenfunction:: kapi::devices::init_platform_drivers
-.. doxygenfunction:: kapi::devices::init_platform_devices
-.. doxygenfunction:: kapi::devices::discover_cpu_topology
-.. doxygenfunction:: kapi::devices::get_cpu_bus
\ No newline at end of file
diff --git a/docs/kapi/devices/busses.rst b/docs/kapi/devices/busses.rst
deleted file mode 100644
index 22b3a79e..00000000
--- a/docs/kapi/devices/busses.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-Busses
-======
\ No newline at end of file
diff --git a/docs/kapi/interrupts.rst b/docs/kapi/interrupts.rst
deleted file mode 100644
index f921b77e..00000000
--- a/docs/kapi/interrupts.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-Interrupt Interface
-===================
-
-API Reference
--------------
-
-.. doxygenfile:: kapi/interrupts.hpp
\ No newline at end of file
diff --git a/docs/kapi/memory.rst b/docs/kapi/memory.rst
deleted file mode 100644
index 9ee15845..00000000
--- a/docs/kapi/memory.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-Memory Interface
-================
-
-Kernel-defined API
-------------------
-
-.. doxygengroup:: kapi-memory-kernel-defined
-    :content-only:
-
-Platform-defined API
---------------------
-
-.. doxygengroup:: kapi-memory-platform-defined
-    :content-only:
diff --git a/docs/kapi/system.rst b/docs/kapi/system.rst
deleted file mode 100644
index 2eaea6de..00000000
--- a/docs/kapi/system.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-System Interface
-================
-
-Kernel-defined API
-------------------
-
-.. doxygengroup:: kapi-system-kernel-defined
-    :content-only:
-
-Platform-defined API
---------------------
-
-.. doxygengroup:: kapi-system-platform-defined
-    :content-only:
diff --git a/docs/kernel.rst b/docs/kernel.rst
deleted file mode 100644
index 39a0dcac..00000000
--- a/docs/kernel.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-Platform-independent Kernel API
-===============================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-   :glob:
-
-   kernel/*
-
diff --git a/docs/kernel/filesystem.rst b/docs/kernel/filesystem.rst
deleted file mode 100644
index 35d92fdc..00000000
--- a/docs/kernel/filesystem.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-Filesystem Layer
-=================
-
-The filesystem layer of the TeachOS kernel comprises all platform-agnostic filesystem entities and operations.
-All platform-independent code related to filesystem implementations resides here.
-This includes the implementations of platform-independent kAPI filesystem types and functions.
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Contents:
-   :glob:
-
-   filesystem/*
-
diff --git a/docs/kernel/filesystem/constants.rst b/docs/kernel/filesystem/constants.rst
deleted file mode 100644
index aa698711..00000000
--- a/docs/kernel/filesystem/constants.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-Global Constants
-================
-
-The constants described here are applicable to all types and functions in the kernel filesystem layers.
-They describe maxima of supported lengths and sizes where not other specification takes precedence.
-
-API Reference
--------------
-
-.. doxygennamespace:: kernel::filesystem::constants
diff --git a/docs/kernel/filesystem/dentry.rst b/docs/kernel/filesystem/dentry.rst
deleted file mode 100644
index 3d40c067..00000000
--- a/docs/kernel/filesystem/dentry.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-Directory Entries
-=================
-
-A directory entry associates a name with an inode.
-As such, a directory entry may refer to any entity represented by an inode.
-Directory entries may be nested.
-
-API Reference
--------------
-
-.. doxygenstruct:: kernel::filesystem::dentry
-    :members:
\ No newline at end of file
diff --git a/docs/kernel/filesystem/device_inode.rst b/docs/kernel/filesystem/device_inode.rst
deleted file mode 100644
index cf5e72fa..00000000
--- a/docs/kernel/filesystem/device_inode.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-Device Inodes
-=============
-
-Device inodes are filesystem inodes that represent a device in the system.
-They may be created from either a device, or by reconstituting a persistent device inode from a filesystem.
-
-An example for device inodes created to directly represent devices are the entries in the devfs (/dev) filesystem.
-Entries in this filesystem are generally created and removed based on devices appearing in and being removed from the system.
-
-An example for device inodes reconstituted from persisted inodes can be found in the inodes supported by the ext2 filesystem.
-In that filesystem, an inode may represent a device, using a device identification number.
-When accessing such an inode, a device inode needs to be reconstituted from the persisted device inode in order to resolve which device, if any, it refers to.
-However, any file operations (e.g. `stat`) need to be forwarded to the persisted inode.
-
-API Reference
--------------
-
-.. doxygenstruct:: kernel::filesystem::device_inode
-    :members:
\ No newline at end of file
diff --git a/docs/kernel/filesystem/inode.rst b/docs/kernel/filesystem/inode.rst
deleted file mode 100644
index 6e36bda1..00000000
--- a/docs/kernel/filesystem/inode.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-Inode Base Class
-=================
-
-An inode (or filesystem index node) represents a filesystem entity, e.g. a file or directory, in the virtual filesystem (VFS).
-While not all filesystems may use traditional inodes, as for example used in ext2, the VFS expects for all entities to be represented as inodes.
-As such, file I/O operation always happen through inodes.
-
-API Reference
--------------
-
-.. doxygenstruct:: kernel::filesystem::inode
-    :members:
\ No newline at end of file