diff options
| author | Felix Morgner <felix.morgner@ost.ch> | 2023-10-17 14:52:17 +0200 |
|---|---|---|
| committer | Felix Morgner <felix.morgner@ost.ch> | 2023-10-17 14:52:17 +0200 |
| commit | f61858725e92d3e77eb8a826a50497045ce67c41 (patch) | |
| tree | f706f75fced7757258d420a7907ba6e17a673ce9 /docs | |
| parent | ab5c964f5dc75eeefefd4af423bf6952497da7a4 (diff) | |
| download | teachos-f61858725e92d3e77eb8a826a50497045ce67c41.tar.xz teachos-f61858725e92d3e77eb8a826a50497045ce67c41.zip | |
doc: introduce basic documentation structure
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/arch.rst | 9 | ||||
| -rw-r--r-- | docs/arch/x86_64.rst | 9 | ||||
| -rw-r--r-- | docs/arch/x86_64/io.rst | 9 | ||||
| -rw-r--r-- | docs/arch/x86_64/io/port_io.rst | 6 | ||||
| -rw-r--r-- | docs/arch/x86_64/video.rst | 9 | ||||
| -rw-r--r-- | docs/arch/x86_64/video/vga.rst | 9 | ||||
| -rw-r--r-- | docs/arch/x86_64/video/vga/io.rst | 4 | ||||
| -rw-r--r-- | docs/arch/x86_64/video/vga/text.rst | 5 | ||||
| -rw-r--r-- | docs/index.rst | 1 |
9 files changed, 61 insertions, 0 deletions
diff --git a/docs/arch.rst b/docs/arch.rst new file mode 100644 index 0000000..495d309 --- /dev/null +++ b/docs/arch.rst @@ -0,0 +1,9 @@ +Platform-Specific Infrastructure +================================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + arch/* diff --git a/docs/arch/x86_64.rst b/docs/arch/x86_64.rst new file mode 100644 index 0000000..dc432f1 --- /dev/null +++ b/docs/arch/x86_64.rst @@ -0,0 +1,9 @@ +x86_64 +====== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + x86_64/*
\ No newline at end of file diff --git a/docs/arch/x86_64/io.rst b/docs/arch/x86_64/io.rst new file mode 100644 index 0000000..7082bd5 --- /dev/null +++ b/docs/arch/x86_64/io.rst @@ -0,0 +1,9 @@ +General Input/Output Subsystem +============================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + io/*
\ No newline at end of file diff --git a/docs/arch/x86_64/io/port_io.rst b/docs/arch/x86_64/io/port_io.rst new file mode 100644 index 0000000..18a9f6a --- /dev/null +++ b/docs/arch/x86_64/io/port_io.rst @@ -0,0 +1,6 @@ +Port-based Input/Output +======================= + +.. doxygenstruct:: teachos::arch::io::port + :members: + diff --git a/docs/arch/x86_64/video.rst b/docs/arch/x86_64/video.rst new file mode 100644 index 0000000..bbae5ed --- /dev/null +++ b/docs/arch/x86_64/video.rst @@ -0,0 +1,9 @@ +Video Output Subsystem +====================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + video/*
\ No newline at end of file diff --git a/docs/arch/x86_64/video/vga.rst b/docs/arch/x86_64/video/vga.rst new file mode 100644 index 0000000..2c32bb2 --- /dev/null +++ b/docs/arch/x86_64/video/vga.rst @@ -0,0 +1,9 @@ +VGA Support +=========== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + vga/* diff --git a/docs/arch/x86_64/video/vga/io.rst b/docs/arch/x86_64/video/vga/io.rst new file mode 100644 index 0000000..39609c9 --- /dev/null +++ b/docs/arch/x86_64/video/vga/io.rst @@ -0,0 +1,4 @@ +VGA Input/Output Types and Constants +==================================== + +.. doxygenfile:: arch/x86_64/include/arch/video/vga/io.hpp diff --git a/docs/arch/x86_64/video/vga/text.rst b/docs/arch/x86_64/video/vga/text.rst new file mode 100644 index 0000000..592cdd5 --- /dev/null +++ b/docs/arch/x86_64/video/vga/text.rst @@ -0,0 +1,5 @@ +VGA Text Mode +============= + +.. doxygennamespace:: teachos::arch::video::vga::text + :members: diff --git a/docs/index.rst b/docs/index.rst index a804c88..e3a749f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,6 +5,7 @@ Welcome to TeachOS Kernel's documentation! :maxdepth: 2 :caption: Contents: + arch cross Indices and tables |