[Docs] Move examples to a new directory (#911)

* [Docs] Move examples to a new directory * fix typo
open-mmlab · Feb 7, 2023 · 4749682 · 4749682
1 parent e35ed5f
commit 4749682
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -251,15 +251,21 @@ runner.train()
 </details>
 
 <details>
-<summary>Common Usage</summary>
+<summary>Examples</summary>
 
-- [Resume Training](https://mmengine.readthedocs.io/en/latest/examples/resume_training.html)
-- [Speed up Training](https://mmengine.readthedocs.io/en/latest/examples/speed_up_training.html)
-- [Save Memory on GPU](https://mmengine.readthedocs.io/en/latest/examples/save_gpu_memory.html)
 - [Train a GAN](https://mmengine.readthedocs.io/en/latest/examples/train_a_gan.html)
 
 </details>
 
+<details>
+<summary>Common Usage</summary>
+
+- [Resume Training](https://mmengine.readthedocs.io/en/latest/common_usage/resume_training.html)
+- [Speed up Training](https://mmengine.readthedocs.io/en/latest/common_usage/speed_up_training.html)
+- [Save Memory on GPU](https://mmengine.readthedocs.io/en/latest/common_usage/save_gpu_memory.html)
+
+</details>
+
 <details>
 <summary>Design</summary>
 

diff --git a/README_zh-CN.md b/README_zh-CN.md
@@ -251,15 +251,21 @@ runner.train()
 </details>
 
 <details>
-<summary>常用功能</summary>
+<summary>示例</summary>
 
-- [恢复训练](https://mmengine.readthedocs.io/zh_CN/latest/examples/resume_training.html)
-- [加速训练](https://mmengine.readthedocs.io/zh_CN/latest/examples/speed_up_training.html)
-- [节省显存](https://mmengine.readthedocs.io/zh_CN/latest/examples/save_gpu_memory.html)
 - [训练生成对抗网络](https://mmengine.readthedocs.io/zh_CN/latest/examples/train_a_gan.html)
 
 </details>
 
+<details>
+<summary>常用功能</summary>
+
+- [恢复训练](https://mmengine.readthedocs.io/zh_CN/latest/common_usage/resume_training.html)
+- [加速训练](https://mmengine.readthedocs.io/zh_CN/latest/common_usage/speed_up_training.html)
+- [节省显存](https://mmengine.readthedocs.io/zh_CN/latest/common_usage/save_gpu_memory.html)
+
+</details>
+
 <details>
 <summary>架构设计</summary>
 

diff --git a/docs/en/examples/resume_training.md → docs/en/common_usage/resume_training.md b/docs/en/examples/resume_training.md → docs/en/common_usage/resume_training.md
diff --git a/docs/en/examples/save_gpu_memory.md → docs/en/common_usage/save_gpu_memory.md b/docs/en/examples/save_gpu_memory.md → docs/en/common_usage/save_gpu_memory.md
diff --git a/docs/en/examples/speed_up_training.md → docs/en/common_usage/speed_up_training.md b/docs/en/examples/speed_up_training.md → docs/en/common_usage/speed_up_training.md
diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -12,13 +12,18 @@ You can switch between Chinese and English documents in the lower-left corner of
 
 .. toctree::
    :maxdepth: 1
-   :caption: Common Usage
+   :caption: Examples
 
-   examples/resume_training.md
-   examples/speed_up_training.md
-   examples/save_gpu_memory.md
    examples/train_a_gan.md
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Common Usage
+
+   common_usage/resume_training.md
+   common_usage/speed_up_training.md
+   common_usage/save_gpu_memory.md
+
 .. toctree::
    :maxdepth: 3
    :caption: Tutorials

diff --git a/docs/zh_cn/examples/resume_training.md → docs/zh_cn/common_usage/resume_training.md b/docs/zh_cn/examples/resume_training.md → docs/zh_cn/common_usage/resume_training.md
diff --git a/docs/zh_cn/examples/save_gpu_memory.md → docs/zh_cn/common_usage/save_gpu_memory.md b/docs/zh_cn/examples/save_gpu_memory.md → docs/zh_cn/common_usage/save_gpu_memory.md
diff --git a/docs/zh_cn/examples/speed_up_training.md → docs/zh_cn/common_usage/speed_up_training.md b/docs/zh_cn/examples/speed_up_training.md → docs/zh_cn/common_usage/speed_up_training.md
diff --git a/docs/zh_cn/index.rst b/docs/zh_cn/index.rst
@@ -12,13 +12,18 @@
 
 .. toctree::
    :maxdepth: 1
-   :caption: 常用功能
+   :caption: 示例
 
-   examples/resume_training.md
-   examples/speed_up_training.md
-   examples/save_gpu_memory.md
    examples/train_a_gan.md
 
+.. toctree::
+   :maxdepth: 1
+   :caption: 常用功能
+
+   common_usage/resume_training.md
+   common_usage/speed_up_training.md
+   common_usage/save_gpu_memory.md
+
 .. toctree::
    :maxdepth: 3
    :caption: 入门教程