diff options
| author | Felix Morgner <felix.morgner@ost.ch> | 2026-08-31 21:45:29 +0200 |
|---|---|---|
| committer | Felix Morgner <felix.morgner@ost.ch> | 2026-08-31 21:45:29 +0200 |
| commit | a8032daf68bc6ff7e345c7ef328252c34e64c599 (patch) | |
| tree | e34ff0e68ccb0ddec6ad3b39c24556738a4344b0 /docs | |
| parent | 3003febdaa0c8b109e56b6c964ae4ee8076b41c1 (diff) | |
| download | kernel-a8032daf68bc6ff7e345c7ef328252c34e64c599.tar.xz kernel-a8032daf68bc6ff7e345c7ef328252c34e64c599.zip | |
docs: update documentation structure
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/briefs.rst | 2 | ||||
| -rw-r--r-- | docs/conf.py | 4 | ||||
| -rw-r--r-- | docs/design.rst | 2 | ||||
| -rw-r--r-- | docs/guides.rst | 9 | ||||
| -rw-r--r-- | docs/guides/device-drivers.rst | 2 | ||||
| -rw-r--r-- | docs/index.rst | 12 |
6 files changed, 27 insertions, 4 deletions
diff --git a/docs/briefs.rst b/docs/briefs.rst index 19313459..36d4c19e 100644 --- a/docs/briefs.rst +++ b/docs/briefs.rst @@ -3,7 +3,7 @@ Technical Briefs .. toctree:: :maxdepth: 1 - :caption: Contents: + :caption: Contents :glob: briefs/* diff --git a/docs/conf.py b/docs/conf.py index 37838427..5ff02d4d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -7,8 +7,8 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "TeachOS Kernel" -copyright = "2023, Felix Morgner" -author = "Felix Morgner" +copyright = "2023, The TeachOS Developers" +author = "The TeachOS Developers" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/docs/design.rst b/docs/design.rst new file mode 100644 index 00000000..33dbc7e1 --- /dev/null +++ b/docs/design.rst @@ -0,0 +1,2 @@ +Design Overview +===============
\ No newline at end of file diff --git a/docs/guides.rst b/docs/guides.rst new file mode 100644 index 00000000..0f5cca62 --- /dev/null +++ b/docs/guides.rst @@ -0,0 +1,9 @@ +Guides and How-Tos +================== + +.. toctree:: + :maxdepth: 1 + :caption: Contents + :glob: + + guides/* diff --git a/docs/guides/device-drivers.rst b/docs/guides/device-drivers.rst new file mode 100644 index 00000000..61a91ddf --- /dev/null +++ b/docs/guides/device-drivers.rst @@ -0,0 +1,2 @@ +Implementing a Device Driver +============================
\ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index f3af6e4f..4e20fa93 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,10 +1,20 @@ TeachOS Kernel Developer Documentation ====================================== +The *TeachOS Kernel Developer Documentation* contains developer documentation beyond the needs of an API documentation. +The API documentation, including internal and library APIs, can be found `here <https://teachos.pages.ost.ch/kernel/api/index.html>`_. + +The goal of the *TeachOS Kernel Developer Documentation* is to provide design overviews, technical briefs, and descriptions of the intended use of certain facilities in the codebase. +Additionally, this documentation provides information on topics such as how to implement device or filesystem drivers. + +Contents +======== + .. toctree:: :maxdepth: 2 - :caption: Contents: + design + guides briefs Indices and tables |