diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 7 | ||||
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/kapi.rst | 10 | ||||
| -rw-r--r-- | docs/kapi/cio.rst | 17 | ||||
| -rw-r--r-- | docs/kapi/cpu.rst | 17 | ||||
| -rw-r--r-- | docs/kapi/devices.rst | 17 | ||||
| -rw-r--r-- | docs/kapi/interrupts.rst | 17 | ||||
| -rw-r--r-- | docs/kapi/memory.rst | 14 | ||||
| -rw-r--r-- | docs/kapi/system.rst | 14 | ||||
| -rw-r--r-- | docs/requirements.txt | 5 |
10 files changed, 114 insertions, 6 deletions
diff --git a/docs/conf.py b/docs/conf.py index b8cfe69..99613b6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,7 +13,7 @@ author = "Felix Morgner" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -#extensions = ["breathe"] +extensions = ["breathe"] templates_path = ["_templates"] exclude_patterns = ["pre/**"] @@ -21,8 +21,9 @@ 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_projects = {"kernel": "../build/doxygen/xml"} +breathe_default_project = "kernel" +breathe_default_members = ('members', 'undoc-members', 'private-members') # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/docs/index.rst b/docs/index.rst index 649e6de..425da57 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,10 +6,10 @@ Welcome to TeachOS Kernel's documentation! :caption: Contents: briefs + kapi Indices and tables ================== * :ref:`genindex` -* :ref:`modindex` * :ref:`search` diff --git a/docs/kapi.rst b/docs/kapi.rst new file mode 100644 index 0000000..4c60ab3 --- /dev/null +++ b/docs/kapi.rst @@ -0,0 +1,10 @@ +Kernel API +========== + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + :glob: + + kapi/* + diff --git a/docs/kapi/cio.rst b/docs/kapi/cio.rst new file mode 100644 index 0000000..62a3639 --- /dev/null +++ b/docs/kapi/cio.rst @@ -0,0 +1,17 @@ +Character I/O Interface +======================= + +.. doxygengroup:: kapi-cio + :content-only: + +Kernel-defined API +------------------ + +.. doxygengroup:: kapi-cio-kernel-defined + :content-only: + +Platform-defined API +-------------------- + +.. doxygengroup:: kapi-cio-platform-defined + :content-only: diff --git a/docs/kapi/cpu.rst b/docs/kapi/cpu.rst new file mode 100644 index 0000000..0793dd8 --- /dev/null +++ b/docs/kapi/cpu.rst @@ -0,0 +1,17 @@ +CPU Interface +============= + +.. doxygengroup:: kapi-cpu + :content-only: + +Kernel-defined API +------------------ + +.. doxygengroup:: kapi-cpu-kernel-defined + :content-only: + +Platform-defined API +-------------------- + +.. doxygengroup:: kapi-cpu-platform-defined + :content-only: diff --git a/docs/kapi/devices.rst b/docs/kapi/devices.rst new file mode 100644 index 0000000..c9853a1 --- /dev/null +++ b/docs/kapi/devices.rst @@ -0,0 +1,17 @@ +Device Interface +================ + +.. doxygengroup:: kapi-devices + :content-only: + +Kernel-defined API +------------------ + +.. doxygengroup:: kapi-devices-kernel-defined + :content-only: + +Platform-defined API +-------------------- + +.. doxygengroup:: kapi-devices-platform-defined + :content-only: diff --git a/docs/kapi/interrupts.rst b/docs/kapi/interrupts.rst new file mode 100644 index 0000000..7150f07 --- /dev/null +++ b/docs/kapi/interrupts.rst @@ -0,0 +1,17 @@ +Interrupt Interface +=================== + +.. doxygengroup:: kapi-interrupts + :content-only: + +Kernel-defined API +------------------ + +.. doxygengroup:: kapi-interrupts-kernel-defined + :content-only: + +Platform-defined API +-------------------- + +.. doxygengroup:: kapi-interrupts-platform-defined + :content-only: diff --git a/docs/kapi/memory.rst b/docs/kapi/memory.rst new file mode 100644 index 0000000..9ee1584 --- /dev/null +++ b/docs/kapi/memory.rst @@ -0,0 +1,14 @@ +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 new file mode 100644 index 0000000..2eaea6d --- /dev/null +++ b/docs/kapi/system.rst @@ -0,0 +1,14 @@ +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/requirements.txt b/docs/requirements.txt index 733e873..fc08790 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ -Sphinx~=8.2.0 -sphinx_book_theme~=1.1.0 +Sphinx~=9.1.0 +sphinx_book_theme~=1.2.0 +breathe~=4.36.0
\ No newline at end of file |