diff --git a/_toc.yml b/_toc.yml index c78b390..31b1b6f 100644 --- a/_toc.yml +++ b/_toc.yml @@ -1,5 +1,15 @@ format: jb-book root: index.md -chapters: - - file: general.md - - file: web_server/README.md +parts: + - caption: 原则 + chapters: + - file: principles/README.md + - caption: 客户端 + chapters: + - file: sdk/README.md + sections: + - file: sdk/api_client.md + - file: cli/README.md + - caption: 服务端 + chapters: + - file: server/README.md \ No newline at end of file diff --git a/cli/README.md b/cli/README.md new file mode 100644 index 0000000..a9fc94c --- /dev/null +++ b/cli/README.md @@ -0,0 +1,4 @@ +# 命令行工具 + +使用[`typer`](https://typer.tiangolo.com)作为主要的命令行开发框架。 +标准库`argparse`(`optparse`已废弃)、第三方库`click`等作为备选框架。 diff --git a/general.md b/principles/README.md similarity index 99% rename from general.md rename to principles/README.md index 524965e..55a22b7 100644 --- a/general.md +++ b/principles/README.md @@ -1,4 +1,4 @@ -# 基本规则 +# 原则 ## 项目结构 diff --git a/sdk/README.md b/sdk/README.md index 8aae8df..3a33b28 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -1,4 +1,4 @@ -# 云SDK类Python依赖 +# SDK ## 预期特性 diff --git a/server/README.md b/server/README.md new file mode 100644 index 0000000..3ff7d01 --- /dev/null +++ b/server/README.md @@ -0,0 +1,3 @@ +# 服务端 + +使用FastAPI作为首选框架。Django和Flask作为备选框架。 diff --git a/web_server/README.md b/web_server/README.md deleted file mode 100644 index 1994e92..0000000 --- a/web_server/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Web服务器 - -使用FastAPI作为首选框架、Django和Flask作为备选框架。