Browse Source

:doc: 完善文档组织结构

fslongjin 2 years ago
parent
commit
7f86e01fd9

+ 6 - 7
docs/index.rst

@@ -10,27 +10,26 @@
    :maxdepth: 1
    :caption: 入门
 
-   introduction/intro
-   introduction/build_system
+   introduction/index
 
 .. toctree::
    :maxdepth: 2
    :caption: 内核层
 
-   kernel/intro
-   
+   kernel/index
+
 
 .. toctree::
    :maxdepth: 2
-   :caption: 用
+   :caption: 用层
 
-   userland/intro
+   userland/index
 
 .. toctree::
    :maxdepth: 2
    :caption: 系统调用api文档
 
-   syscall_api/intro
+   syscall_api/index
 
 
 Indices and tables

+ 9 - 0
docs/introduction/index.rst

@@ -0,0 +1,9 @@
+入门
+====================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: LibC
+
+   intro
+   build_system

+ 8 - 0
docs/kernel/bootloader/index.rst

@@ -0,0 +1,8 @@
+引导加载程序
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: bl
+
+   intro

+ 1 - 0
docs/kernel/bootloader/intro.md

@@ -0,0 +1 @@
+### 简介

+ 8 - 0
docs/kernel/index.rst

@@ -0,0 +1,8 @@
+内核层
+====================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: 引导加载程序
+
+   bootloader/index

+ 0 - 1
docs/kernel/intro.md

@@ -1 +0,0 @@
-# 内核层

+ 8 - 0
docs/syscall_api/index.rst

@@ -0,0 +1,8 @@
+系统调用API
+====================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: 系统调用API
+
+   intro

+ 1 - 1
docs/syscall_api/intro.md

@@ -1 +1 @@
-# 系统调用API文档
+# 简介

+ 9 - 0
docs/userland/index.rst

@@ -0,0 +1,9 @@
+应用层
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: LibC
+
+   intro
+   libc/index

+ 8 - 0
docs/userland/libc/index.rst

@@ -0,0 +1,8 @@
+LibC文档
+====================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: LibC
+
+   intro

+ 1 - 0
docs/userland/libc/intro.md

@@ -0,0 +1 @@
+## 简介