【重构】重构readme文件

README.md

@@ -0,0 +1,18 @@
+# [计算机通用基础知识](./README.md)
+
+## 目录结构
+
+### [操作系统](./docs/操作系统/README.md)
+
+### [数据结构](./docs/数据结构/README.md)
+
+### [计算机组成原理](./docs/计算机组成原理/README.md)
+
+### [计算机网络](./docs/计算机网络/README.md)
+
+## 部署
+
+```sh
+pip install mkdocs
+mkdocs serve
+```

docs/README.md

@@ -6,268 +6,58 @@
 
 ### [1-计算机系统概述](./操作系统/1-计算机系统概述/README.md)
 
-#### [1.1-操作系统的基本概念](./操作系统/1-计算机系统概述/1.1-操作系统的基本概念/README.md)
-
-#### [1.2-操作系统的发展与分类](./操作系统/1-计算机系统概述/1.2-操作系统的发展与分类/README.md)
-
-#### [1.3-操作系统的运行环境](./操作系统/1-计算机系统概述/1.3-操作系统的运行环境/README.md)
-
-#### [1.4-操作系统的体系结构](./操作系统/1-计算机系统概述/1.4-操作系统的体系结构/README.md)
-
 ### [2-进程管理](./操作系统/2-进程管理/README.md)
 
-#### [2.1-进程和线程](./操作系统/2-进程管理/2.1-进程和线程/README.md)
-
-#### [2.2-处理机的调度](./操作系统/2-进程管理/2.2-处理机的调度/README.md)
-
-#### [2.3-进程同步](./操作系统/2-进程管理/2.3-进程同步/README.md)
-
-#### [2.4-死锁-Deadlocked](./操作系统/2-进程管理/2.4-死锁-Deadlocked/README.md)
-
 ### [3-内存管理](./操作系统/3-内存管理/README.md)
 
-#### [3.1-内存管理概念](./操作系统/3-内存管理/3.1-内存管理概念/README.md)
-
-#### [3.2-虚拟内存管理](./操作系统/3-内存管理/3.2-虚拟内存管理/README.md)
-
 ### [4-文件管理](./操作系统/4-文件管理/README.md)
 
-#### [4.1-文件系统基础](./操作系统/4-文件管理/4.1-文件系统基础/README.md)
-
-#### [4.2-文件系统实现](./操作系统/4-文件管理/4.2-文件系统实现/README.md)
-
-#### [4.3-磁盘组织和管理](./操作系统/4-文件管理/4.3-磁盘组织和管理/README.md)
-
 ### [5-输入输出管理](./操作系统/5-输入输出管理/README.md)
 
-#### [5.1-IO-管理概述](./操作系统/5-输入输出管理/5.1-IO-管理概述/README.md)
-
-#### [5.2-IO-核心子系统](./操作系统/5-输入输出管理/5.2-IO-核心子系统/README.md)
-
 ## [数据结构](./数据结构/README.md)
 
 ### [1-绪论](./数据结构/1-绪论/README.md)
 
-#### [1.1-数据结构的基本概念](./数据结构/1-绪论/1.1-数据结构的基本概念/README.md)
-
-#### [1.2-算法和算法评价](./数据结构/1-绪论/1.2-算法和算法评价/README.md)
-
 ### [2-线性表](./数据结构/2-线性表/README.md)
 
-#### [2.1-线性表的定义和基本操作](./数据结构/2-线性表/2.1-线性表的定义和基本操作/README.md)
-
-#### [2.2-线性表的顺序表示](./数据结构/2-线性表/2.2-线性表的顺序表示/README.md)
-
-#### [2.3-线性表的链式表示](./数据结构/2-线性表/2.3-线性表的链式表示/README.md)
-
 ### [3-栈和队列](./数据结构/3-栈和队列/README.md)
 
-#### [3.1-栈-Stack](./数据结构/3-栈和队列/3.1-栈-Stack/README.md)
-
-#### [3.2-队列-Queue](./数据结构/3-栈和队列/3.2-队列-Queue/README.md)
-
-#### [3.3-栈和队列的应用](./数据结构/3-栈和队列/3.3-栈和队列的应用/README.md)
-
-#### [3.4-特殊矩阵和压缩存储](./数据结构/3-栈和队列/3.4-特殊矩阵和压缩存储/README.md)
-
 ### [4-串](./数据结构/4-串/README.md)
 
-#### [4.1-串的定义和实现](./数据结构/4-串/4.1-串的定义和实现/README.md)
-
-#### [4.2-串的匹配模式](./数据结构/4-串/4.2-串的匹配模式/README.md)
-
 ### [5-树和二叉树](./数据结构/5-树和二叉树/README.md)
 
-#### [5.1-树的基本概念](./数据结构/5-树和二叉树/5.1-树的基本概念/README.md)
-
-#### [5.2-二叉树的概念](./数据结构/5-树和二叉树/5.2-二叉树的概念/README.md)
-
-#### [5.3-二叉树的遍历和线索二叉树](./数据结构/5-树和二叉树/5.3-二叉树的遍历和线索二叉树/README.md)
-
-#### [5.4-树、森林-Tree-Forest](./数据结构/5-树和二叉树/5.4-树、森林-Tree-Forest/README.md)
-
-#### [5.5-树与二叉树的应用](./数据结构/5-树和二叉树/5.5-树与二叉树的应用/README.md)
-
 ### [6-图](./数据结构/6-图/README.md)
 
-#### [6.1-图的基本概念](./数据结构/6-图/6.1-图的基本概念/README.md)
-
-#### [6.2-图的存储及基本操作](./数据结构/6-图/6.2-图的存储及基本操作/README.md)
-
-#### [6.3-图的遍历](./数据结构/6-图/6.3-图的遍历/README.md)
-
-#### [6.4-图的应用](./数据结构/6-图/6.4-图的应用/README.md)
-
 ### [7-查找](./数据结构/7-查找/README.md)
 
-#### [7.1-查找的基本概念](./数据结构/7-查找/7.1-查找的基本概念/README.md)
-
-#### [7.2-顺序查找和折半查找](./数据结构/7-查找/7.2-顺序查找和折半查找/README.md)
-
-#### [7.3-B-树和-B+树](./数据结构/7-查找/7.3-B-树和-B+树/README.md)
-
-#### [7.4-散列表](./数据结构/7-查找/7.4-散列表/README.md)
-
 ### [8-排序](./数据结构/8-排序/README.md)
 
-#### [8.1-排序的基本概念](./数据结构/8-排序/8.1-排序的基本概念/README.md)
-
-#### [8.2-插入排序](./数据结构/8-排序/8.2-插入排序/README.md)
-
-#### [8.3-交换排序](./数据结构/8-排序/8.3-交换排序/README.md)
-
-#### [8.4-选择排序](./数据结构/8-排序/8.4-选择排序/README.md)
-
-#### [8.5-归并排序和基数排序](./数据结构/8-排序/8.5-归并排序和基数排序/README.md)
-
-#### [8.6-各种内部排序算法的比较及应用](./数据结构/8-排序/8.6-各种内部排序算法的比较及应用/README.md)
-
-#### [8.7-外部排序](./数据结构/8-排序/8.7-外部排序/README.md)
-
 ## [计算机组成原理](./计算机组成原理/README.md)
 
 ### [1-计算机系统概述](./计算机组成原理/1-计算机系统概述/README.md)
 
-#### [1.1-计算机发展历程](./计算机组成原理/1-计算机系统概述/1.1-计算机发展历程/README.md)
-
-#### [1.2-计算机系统层次结构](./计算机组成原理/1-计算机系统概述/1.2-计算机系统层次结构/README.md)
-
-#### [1.3-计算机的性能指标](./计算机组成原理/1-计算机系统概述/1.3-计算机的性能指标/README.md)
-
 ### [2-数据的表示和运算](./计算机组成原理/2-数据的表示和运算/README.md)
 
-#### [2.1-数制与编码](./计算机组成原理/2-数据的表示和运算/2.1-数制与编码/README.md)
-
-#### [2.2-定点数的表示和计算-Fixed-point-Number](./计算机组成原理/2-数据的表示和运算/2.2-定点数的表示和计算-Fixed-point-Number/README.md)
-
-#### [2.3-浮点数的表示和运算-Floating-point-Number](./计算机组成原理/2-数据的表示和运算/2.3-浮点数的表示和运算-Floating-point-Number/README.md)
-
-#### [2.4-算术逻辑单元-ALU](./计算机组成原理/2-数据的表示和运算/2.4-算术逻辑单元-ALU/README.md)
-
 ### [3-存储系统](./计算机组成原理/3-存储系统/README.md)
 
-#### [3.1-存储器概述](./计算机组成原理/3-存储系统/3.1-存储器概述/README.md)
-
-#### [3.2-存储器的层次化结构](./计算机组成原理/3-存储系统/3.2-存储器的层次化结构/README.md)
-
-#### [3.3-半导体随机存储器](./计算机组成原理/3-存储系统/3.3-半导体随机存储器/README.md)
-
-#### [3.4-主存储器与-CPU-的连接-Main-Memory](./计算机组成原理/3-存储系统/3.4-主存储器与-CPU-的连接-Main-Memory/README.md)
-
-#### [3.5-双端口-RAM-和多模块存储器](./计算机组成原理/3-存储系统/3.5-双端口-RAM-和多模块存储器/README.md)
-
-#### [3.6-高速缓冲存储器-Cache](./计算机组成原理/3-存储系统/3.6-高速缓冲存储器-Cache/README.md)
-
-#### [3.7-虚拟存储器](./计算机组成原理/3-存储系统/3.7-虚拟存储器/README.md)
-
 ### [4-指令系统](./计算机组成原理/4-指令系统/README.md)
 
-#### [4.1-指令格式](./计算机组成原理/4-指令系统/4.1-指令格式/README.md)
-
-#### [4.2-指令的寻址方式](./计算机组成原理/4-指令系统/4.2-指令的寻址方式/README.md)
-
-#### [4.3-CISC-和-RISC-的基本概念](./计算机组成原理/4-指令系统/4.3-CISC-和-RISC-的基本概念/README.md)
-
 ### [5-中央处理器](./计算机组成原理/5-中央处理器/README.md)
 
-#### [5.1-CPU-的功能和基本结构](./计算机组成原理/5-中央处理器/5.1-CPU-的功能和基本结构/README.md)
-
-#### [5.2-指令执行过程](./计算机组成原理/5-中央处理器/5.2-指令执行过程/README.md)
-
-#### [5.3-数据通路的功能和基本结构](./计算机组成原理/5-中央处理器/5.3-数据通路的功能和基本结构/README.md)
-
-#### [5.4-控制器的功能和工作原理](./计算机组成原理/5-中央处理器/5.4-控制器的功能和工作原理/README.md)
-
-#### [5.5-指令流水线](./计算机组成原理/5-中央处理器/5.5-指令流水线/README.md)
-
 ### [6-总线](./计算机组成原理/6-总线/README.md)
 
-#### [6.1-总线概述](./计算机组成原理/6-总线/6.1-总线概述/README.md)
-
-#### [6.2-总线仲裁](./计算机组成原理/6-总线/6.2-总线仲裁/README.md)
-
-#### [6.3-总线操作和定时](./计算机组成原理/6-总线/6.3-总线操作和定时/README.md)
-
-#### [6.4-总线标准](./计算机组成原理/6-总线/6.4-总线标准/README.md)
-
 ### [7-输入输出系统IO](./计算机组成原理/7-输入输出系统IO/README.md)
 
-#### [7.1-IO-系统基本概念](./计算机组成原理/7-输入输出系统IO/7.1-IO-系统基本概念/README.md)
-
-#### [7.2-外部设备](./计算机组成原理/7-输入输出系统IO/7.2-外部设备/README.md)
-
-#### [7.3-IO-接口](./计算机组成原理/7-输入输出系统IO/7.3-IO-接口/README.md)
-
-#### [7.4-IO-方式](./计算机组成原理/7-输入输出系统IO/7.4-IO-方式/README.md)
-
 ## [计算机网络](./计算机网络/README.md)
 
 ### [1-计算机网络体系结构](./计算机网络/1-计算机网络体系结构/README.md)
 
-#### [1.1-计算机网络概述](./计算机网络/1-计算机网络体系结构/1.1-计算机网络概述/README.md)
-
-#### [1.2-计算机网络体系结构和参考模型](./计算机网络/1-计算机网络体系结构/1.2-计算机网络体系结构和参考模型/README.md)
-
 ### [2-物理层](./计算机网络/2-物理层/README.md)
 
-#### [2.1-通信基础](./计算机网络/2-物理层/2.1-通信基础/README.md)
-
-#### [2.2-传输介质](./计算机网络/2-物理层/2.2-传输介质/README.md)
-
-#### [2.3-物理层设备](./计算机网络/2-物理层/2.3-物理层设备/README.md)
-
 ### [3-数据链路层](./计算机网络/3-数据链路层/README.md)
 
-#### [3.1-数据链路层的功能](./计算机网络/3-数据链路层/3.1-数据链路层的功能/README.md)
-
-#### [3.2-组帧](./计算机网络/3-数据链路层/3.2-组帧/README.md)
-
-#### [3.3-差错控制](./计算机网络/3-数据链路层/3.3-差错控制/README.md)
-
-#### [3.4-流量控制与可靠传输机制](./计算机网络/3-数据链路层/3.4-流量控制与可靠传输机制/README.md)
-
-#### [3.5-介质访问控制-MAC](./计算机网络/3-数据链路层/3.5-介质访问控制-MAC/README.md)
-
-#### [3.6-局域网-LAN](./计算机网络/3-数据链路层/3.6-局域网-LAN/README.md)
-
-#### [3.7-广域网-WAN](./计算机网络/3-数据链路层/3.7-广域网-WAN/README.md)
-
-#### [3.8-数据链路层的设备](./计算机网络/3-数据链路层/3.8-数据链路层的设备/README.md)
-
 ### [4-网络层](./计算机网络/4-网络层/README.md)
 
-#### [4.1-网络层的功能](./计算机网络/4-网络层/4.1-网络层的功能/README.md)
-
-#### [4.2-路由算法](./计算机网络/4-网络层/4.2-路由算法/README.md)
-
-#### [4.3-IPv4](./计算机网络/4-网络层/4.3-IPv4/README.md)
-
-#### [4.4-IPv6](./计算机网络/4-网络层/4.4-IPv6/README.md)
-
-#### [4.5-路由协议](./计算机网络/4-网络层/4.5-路由协议/README.md)
-
-#### [4.6-IP-组播](./计算机网络/4-网络层/4.6-IP-组播/README.md)
-
-#### [4.7-移动-IP](./计算机网络/4-网络层/4.7-移动-IP/README.md)
-
-#### [4.8-网络层设备](./计算机网络/4-网络层/4.8-网络层设备/README.md)
-
 ### [5-传输层](./计算机网络/5-传输层/README.md)
 
-#### [5.1-传输层提供的服务](./计算机网络/5-传输层/5.1-传输层提供的服务/README.md)
-
-#### [5.2-UDP-协议](./计算机网络/5-传输层/5.2-UDP-协议/README.md)
-
-#### [5.3-TCP-协议](./计算机网络/5-传输层/5.3-TCP-协议/README.md)
-
-### [6-应用层](./计算机网络/6-应用层/README.md)
-
-#### [6.1-网络应用模型](./计算机网络/6-应用层/6.1-网络应用模型/README.md)
-
-#### [6.2-域名系统-DNS](./计算机网络/6-应用层/6.2-域名系统-DNS/README.md)
-
-#### [6.3-文件传输协议-FTP](./计算机网络/6-应用层/6.3-文件传输协议-FTP/README.md)
-
-#### [6.4-电子邮件-eMail](./计算机网络/6-应用层/6.4-电子邮件-eMail/README.md)
-
-#### [6.5-万维网-www](./计算机网络/6-应用层/6.5-万维网-www/README.md)
+### [6-应用层](./计算机网络/6-应用层/README.md)

mkdocs.yml

@@ -1 +1,3 @@
 site_name: 408计算机知识架构
+theme:
+  name: readthedocs

scripts/1-从文件结构生成目录.py

@@ -53,21 +53,26 @@ def generate_dir_structure(path:Path, prefix:str) -> dict:
 
 
 
-def generate_readme_from_dict(tree:dict, depth:int=0) -> str:
+def generate_readme_from_dict(tree:dict, depth:int=0, limit=2) -> str:
     """从目录树结构生成对应的readme.py
 
     Args:
         tree (dict): 目录树字典结构
         depth (int, optional): 树的深度. Defaults to 0.
+        limit (int, optional): 表示最深的目录结构, Defaults to 2
 
     Returns:
         str: 返回要生成的md字符串
     """
     content = []
+    if depth > limit:
+        return
     template =(depth+1)*"#" + " " + "[{}]({})"
     for key, value in tree.items():
         if isinstance(value, dict):
-            content.append(generate_readme_from_dict(value, depth+1))
+            ret = generate_readme_from_dict(value, depth+1)
+            if ret:
+                content.append(ret)
         else:
             content.insert(0, template.format(key, value))
     return "\n\n".join(content)
@@ -116,11 +121,8 @@ def run_recursive(path:Path):
 
 
 if __name__ == '__main__':
-    # 如果有其他文件目录需要生成，可以注册到这里
     src = Path("./docs")
-
     run_recursive(src)
-    # shutil.move(src + '/README.md', "./README.md")