From 359b9b5eb2379cae57b9b3745df2c9cf6750b672 Mon Sep 17 00:00:00 2001 From: sibo2rr <1415419833@qq.com> Date: Wed, 5 Jan 2022 11:13:17 +0800 Subject: [PATCH] change subtitle order --- docs/zh_CN/advanced_tutorials/index.rst | 8 +- docs/zh_CN/faq_series/index.rst | 2 +- .../image_recognition_pipeline/index.rst | 2 +- docs/zh_CN/inference_deployment/index.rst | 13 +- .../paddle_serving_deploy.md | 4 +- docs/zh_CN/others/course_link.md | 2 +- docs/zh_CN/others/index.rst | 19 +- docs/zh_CN/others/paddle_mobile_inference.md | 2 +- docs/zh_CN/readFile.py | 64 ------- "readthedoc\346\214\207\345\215\227.md" | 166 ------------------ 10 files changed, 31 insertions(+), 251 deletions(-) delete mode 100644 docs/zh_CN/readFile.py delete mode 100644 "readthedoc\346\214\207\345\215\227.md" diff --git a/docs/zh_CN/advanced_tutorials/index.rst b/docs/zh_CN/advanced_tutorials/index.rst index 7cb53030..760ec5ce 100644 --- a/docs/zh_CN/advanced_tutorials/index.rst +++ b/docs/zh_CN/advanced_tutorials/index.rst @@ -4,8 +4,10 @@ .. toctree:: :maxdepth: 2 - model_prune_quantization.md + DataAugmentation.md knowledge_distillation.md - how_to_contribute.md + model_prune_quantization.md code_overview.md - DataAugmentation.md + how_to_contribute.md + + diff --git a/docs/zh_CN/faq_series/index.rst b/docs/zh_CN/faq_series/index.rst index f65427df..225b82dc 100644 --- a/docs/zh_CN/faq_series/index.rst +++ b/docs/zh_CN/faq_series/index.rst @@ -6,5 +6,5 @@ FAQ系列 faq_2021_s2.md faq_2021_s1.md - faq_selected_30.md faq_2020_s1.md + faq_selected_30.md diff --git a/docs/zh_CN/image_recognition_pipeline/index.rst b/docs/zh_CN/image_recognition_pipeline/index.rst index 3931a420..6cf5e5a6 100644 --- a/docs/zh_CN/image_recognition_pipeline/index.rst +++ b/docs/zh_CN/image_recognition_pipeline/index.rst @@ -4,6 +4,6 @@ .. toctree:: :maxdepth: 2 - vector_search.md mainbody_detection.md feature_extraction.md + vector_search.md diff --git a/docs/zh_CN/inference_deployment/index.rst b/docs/zh_CN/inference_deployment/index.rst index 0148ad16..beddc138 100644 --- a/docs/zh_CN/inference_deployment/index.rst +++ b/docs/zh_CN/inference_deployment/index.rst @@ -4,11 +4,14 @@ .. toctree:: :maxdepth: 2 - paddle_serving_deploy.md - whl_deploy.md - cpp_deploy_on_windows.md + export_model.md python_deploy.md - paddle_hub_serving_deploy.md cpp_deploy.md + paddle_serving_deploy.md + paddle_hub_serving_deploy.md paddle_lite_deploy.md - export_model.md + whl_deploy.md + cpp_deploy_on_windows.md + + + diff --git a/docs/zh_CN/inference_deployment/paddle_serving_deploy.md b/docs/zh_CN/inference_deployment/paddle_serving_deploy.md index 99c3e45b..cf660ba0 100644 --- a/docs/zh_CN/inference_deployment/paddle_serving_deploy.md +++ b/docs/zh_CN/inference_deployment/paddle_serving_deploy.md @@ -1,5 +1,5 @@ -# 模型服务化部署\ ----- +# 模型服务化部署 +-------- ## 目录 - [1. 简介](#1) - [2. Serving 安装](#2) diff --git a/docs/zh_CN/others/course_link.md b/docs/zh_CN/others/course_link.md index 8f4135b4..17763207 100644 --- a/docs/zh_CN/others/course_link.md +++ b/docs/zh_CN/others/course_link.md @@ -1,4 +1,4 @@ -# 往期课程链接： +# 往期课程链接 --- - [**【AI快车道PaddleClas系列直播课】**](https://aistudio.baidu.com/aistudio/course/introduce/24519) diff --git a/docs/zh_CN/others/index.rst b/docs/zh_CN/others/index.rst index f21f70fe..1141b41b 100644 --- a/docs/zh_CN/others/index.rst +++ b/docs/zh_CN/others/index.rst @@ -4,12 +4,17 @@ .. toctree:: :maxdepth: 2 - competition_support.md - paddle_mobile_inference.md - feature_visiualization.md - VisualDL.md - versions.md - update_history.md - train_on_xpu.md transfer_learning.md train_with_DALI.md + VisualDL.md + train_on_xpu.md + feature_visiualization.md + paddle_mobile_inference.md + course_link.md + competition_support.md + update_history.md + versions.md + + + + diff --git a/docs/zh_CN/others/paddle_mobile_inference.md b/docs/zh_CN/others/paddle_mobile_inference.md index d1a156b1..849190d6 100644 --- a/docs/zh_CN/others/paddle_mobile_inference.md +++ b/docs/zh_CN/others/paddle_mobile_inference.md @@ -1,4 +1,4 @@ -# Paddle-Lite +# 手机端 benchmark --- ## 目录 diff --git a/docs/zh_CN/readFile.py b/docs/zh_CN/readFile.py deleted file mode 100644 index 7cb48d5d..00000000 --- a/docs/zh_CN/readFile.py +++ /dev/null @@ -1,64 +0,0 @@ -import os - -def file_name(file_dir): - temp = [] - for root, dirs, files in os.walk(file_dir): - print(dirs) #当前路径下所有子目录 - temp = dirs #存储需要的子目录 - break - - # 删除不需要的子目录 - temp.remove('_templates') - temp.remove('_build') - temp.remove('_static') - chinese_name = ['模型训练', '介绍', '图像识别流程', '其他', 'FAQ系列', '数据准备', '安装', '模型库', '高级教程', '算法介绍', '推理部署', '快速开始'] - # 写根目录下的rst文件 - with open('./index.rst', 'w') as f: - f.write('欢迎使用PaddleClas图像分类库！\n') - f.write('================================\n\n') - f.write('.. toctree::\n') - f.write(' :maxdepth: 1\n\n') - for dir in temp: - f.write(' ' + dir + '/index\n') - f.close() - - # 写各个子目录下的rst文件 - for dir in temp: - for root, dirs, files in os.walk(dir): - print(root) #当前目录路径 - if 'index.rst' in files: - files.remove('index.rst') - print(files) #当前路径下所有非目录子文件 - curDir = os.path.join(file_dir, dir) - filename = curDir + '/index.rst' - idx = temp.index(dir) - ch_name = chinese_name[idx] - with open(filename, 'w') as f: - f.write(ch_name+'\n') - f.write('================================\n\n') - f.write('.. toctree::\n') - f.write(' :maxdepth: 2\n\n') - - for f1 in files: - f.write(' ' + f1 + '\n') - - f.close() - - -def readfile(filename): - file = open(filename) - i = 0 - while 1: - line = file.readline() - print(i) - print(line) - i += 1 - if not line: - break - pass # do something - file.close() - - -file_name('./') -#filename = './index.rst' -#readfile(filename) diff --git "a/readthedoc\346\214\207\345\215\227.md" "b/readthedoc\346\214\207\345\215\227.md" deleted file mode 100644 index a25626b2..00000000 --- "a/readthedoc\346\214\207\345\215\227.md" +++ /dev/null @@ -1,166 +0,0 @@ -1. 注册ReadtheDocs并连接到github - -2. 在github上将项目克隆到本地 - -3. 在本地仓库中安装Sphinx - - ```shell - pip install sphinx - ``` - -4. 创建工程 - - ```shell - sphinx-quickstart - ``` - -5. 对工程进行配置 - - 5.1 更改主题 - - 在source/conf.py中更改或添加如下代码 - - ```python - import sphinx_rtd_theme - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - ``` - - 5.2 添加markdown支持和markdown表格支持 - - 首先需要安装recommonmark和sphinx_markdown_tables - - ```shell - pip install recommonmark - pip install sphinx_markdown_tables - ``` - - 在source/conf.py中更改或添加如下代码 - - ```python - from recommonmark.parser import CommonMarkParser - source_parsers = { - '.md': CommonMarkParser, - } - source_suffix = ['.rst', '.md'] - extensions = [ - 'recommonmark', - 'sphinx_markdown_tables' - ] - ``` - - 以上五步具体效果可以参考https://www.jianshu.com/p/d1d59d0cd58c - -6. 在创建好项目以后，根目录下应该有如下几个文件： - - - **Makefile**：在使用 `make` 命令时，可以使用这些指令（e.g. `sphinx-build`）来构建文档输出。 - - **_build**：这是触发特定输出后用来存放所生成的文件的目录。 - - **_static**：所有不属于源代码（e.g. 图片）一部分的文件均存放于此处，稍后会在构建目录中将它们链接在一起。 - - **conf.py**：用于存放 Sphinx 的配置值，包括在终端执行 `sphinx-quickstart`时选中的那些值。 - - **index.rst**：文档项目的 root 目录。如果将文档划分为其他文件，该目录会连接这些文件 - -7. **编写文档**：在 index.rst 文件中的主标题之后，有一个内容清单，其中包括 `toctree` 声明，它将所有文档链接都汇集到 Index。 - - 以根目录下的index.rst为例： - - ```rst - 欢迎使用PaddleClas图像分类库！ - ================================ - - .. toctree:: - :maxdepth: 1 - - models_training/index - introduction/index - image_recognition_pipeline/index - others/index - faq_series/index - data_preparation/index - installation/index - models/index - advanced_tutorials/index - algorithm_introduction/index - inference_deployment/index - quick_start/index - ``` - - 可以用下面的python代码实现根目录和各个子目录下的`index.rst`文件的编写 - - 注意：此代码应该在需要生成文档书的文件夹根目录上运行 - - ```python - import os - - def file_name(file_dir): - temp = [] - for root, dirs, files in os.walk(file_dir): - print(dirs) #当前路径下所有子目录 - temp = dirs #存储需要的子目录 - break - - # 删除不需要的子目录 - temp.remove('images') - temp.remove('_templates') - temp.remove('_build') - temp.remove('_static') - chinese_name = ['模型训练', '介绍', '图像识别流程', '其他', 'FAQ系列', '数据准备', '安装', '模型库', '高级教程', '算法介绍', '推理部署', '快速开始'] - # 写根目录下的rst文件 - with open('./index.rst', 'w') as f: - f.write('欢迎使用PaddleClas图像分类库！\n') - f.write('================================\n\n') - f.write('.. toctree::\n') - f.write(' :maxdepth: 1\n\n') - for dir in temp: - f.write(' ' + dir + '/index\n') - f.close() - - # 写各个子目录下的rst文件 - for dir in temp: - for root, dirs, files in os.walk(dir): - print(root) #当前目录路径 - - files.remove('index.rst') - print(files) #当前路径下所有非目录子文件 - curDir = os.path.join(file_dir, dir) - filename = curDir + '/index.rst' - idx = temp.index(dir) - ch_name = chinese_name[idx] - with open(filename, 'w') as f: - f.write(ch_name+'\n') - f.write('================================\n\n') - f.write('.. toctree::\n') - f.write(' :maxdepth: 2\n\n') - - for f1 in files: - f.write(' ' + f1 + '\n') - - f.close() - - - def readfile(filename): - file = open(filename) - i = 0 - while 1: - line = file.readline() - print(i) - print(line) - i += 1 - if not line: - break - pass # do something - file.close() - - - file_name('./') - # filename = './index.rst' - # readfile(filename) - ``` - -8. 生成文档 - - 运行 `make html` 命令 - -9. 使用浏览器查看在build/html目录下的 `index.html`文件可以查看静态网页 - - - -- GitLab