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

* [Docs] Move examples to a new directory

* fix typo

README.md

@@ -250,13 +250,19 @@ runner.train()
 
 </details>
 
+<details>
+<summary>Examples</summary>
+
+- [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/examples/resume_training.html)
+- [Resume Training](https://mmengine.readthedocs.io/en/latest/common_usage/resume_training.html)
-- [Speed up Training](https://mmengine.readthedocs.io/en/latest/examples/speed_up_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/examples/save_gpu_memory.html)
+- [Save Memory on GPU](https://mmengine.readthedocs.io/en/latest/common_usage/save_gpu_memory.html)
-- [Train a GAN](https://mmengine.readthedocs.io/en/latest/examples/train_a_gan.html)
 
 </details>
 

README_zh-CN.md

@@ -250,13 +250,19 @@ runner.train()
 
 </details>
 
+<details>
+<summary>示例</summary>
+
+- [训练生成对抗网络](https://mmengine.readthedocs.io/zh_CN/latest/examples/train_a_gan.html)
+
+</details>
+
 <details>
 <summary>常用功能</summary>
 
-- [恢复训练](https://mmengine.readthedocs.io/zh_CN/latest/examples/resume_training.html)
+- [恢复训练](https://mmengine.readthedocs.io/zh_CN/latest/common_usage/resume_training.html)
-- [加速训练](https://mmengine.readthedocs.io/zh_CN/latest/examples/speed_up_training.html)
+- [加速训练](https://mmengine.readthedocs.io/zh_CN/latest/common_usage/speed_up_training.html)
-- [节省显存](https://mmengine.readthedocs.io/zh_CN/latest/examples/save_gpu_memory.html)
+- [节省显存](https://mmengine.readthedocs.io/zh_CN/latest/common_usage/save_gpu_memory.html)
-- [训练生成对抗网络](https://mmengine.readthedocs.io/zh_CN/latest/examples/train_a_gan.html)
 
 </details>
 

docs/en/index.rst

@@ -10,14 +10,19 @@ You can switch between Chinese and English documents in the lower-left corner of
    get_started/installation.md
    get_started/15_minutes.md
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Examples
+
+   examples/train_a_gan.md
+
 .. toctree::
    :maxdepth: 1
    :caption: Common Usage
 
-   examples/resume_training.md
+   common_usage/resume_training.md
-   examples/speed_up_training.md
+   common_usage/speed_up_training.md
-   examples/save_gpu_memory.md
+   common_usage/save_gpu_memory.md
-   examples/train_a_gan.md
 
 .. toctree::
    :maxdepth: 3

docs/zh_cn/index.rst

@@ -10,14 +10,19 @@
    get_started/installation.md
    get_started/15_minutes.md
 
+.. toctree::
+   :maxdepth: 1
+   :caption: 示例
+
+   examples/train_a_gan.md
+
 .. toctree::
    :maxdepth: 1
    :caption: 常用功能
 
-   examples/resume_training.md
+   common_usage/resume_training.md
-   examples/speed_up_training.md
+   common_usage/speed_up_training.md
-   examples/save_gpu_memory.md
+   common_usage/save_gpu_memory.md
-   examples/train_a_gan.md
 
 .. toctree::
    :maxdepth: 3