[Docs] Update docs. (#600)

* [Docs] The template provides united Docs and OpenMMLab drop-lists in
banner. Remove them from our `conf.py`.

* Move docs of different languages to the same folder

README.md

@@ -44,11 +44,11 @@ Highlights of this version:
 - Support **ImageNet21k** dataset.
 - Add a **pipeline visualization** tool. Try it with the [tutorials](https://mmclassification.readthedocs.io/en/latest/tools/visualization.html#pipeline-visualization)!
 
-Please refer to [changelog.md](docs/changelog.md) for more details and other release history.
+Please refer to [changelog.md](docs/en/changelog.md) for more details and other release history.
 
 ## Benchmark and model zoo
 
-Results and models are available in the [model zoo](docs/model_zoo.md).
+Results and models are available in the [model zoo](docs/en/model_zoo.md).
 
 Supported backbones:
 
@@ -74,21 +74,21 @@ Supported backbones:
 
 ## Installation
 
-Please refer to [install.md](docs/install.md) for installation and dataset preparation.
+Please refer to [install.md](docs/en/install.md) for installation and dataset preparation.
 
 ## Getting Started
-Please see [getting_started.md](docs/getting_started.md) for the basic usage of MMClassification. There are also tutorials:
+Please see [getting_started.md](docs/en/getting_started.md) for the basic usage of MMClassification. There are also tutorials:
 
-- [learn about configs](docs/tutorials/config.md)
-- [finetuning models](docs/tutorials/finetune.md)
-- [adding new dataset](docs/tutorials/new_dataset.md)
-- [designing data pipeline](docs/tutorials/data_pipeline.md)
-- [adding new modules](docs/tutorials/new_modules.md)
-- [customizing schedule](docs/tutorials/schedule.md)
-- [customizing runtime settings](docs/tutorials/runtime.md)
+- [learn about configs](docs/en/tutorials/config.md)
+- [finetuning models](docs/en/tutorials/finetune.md)
+- [adding new dataset](docs/en/tutorials/new_dataset.md)
+- [designing data pipeline](docs/en/tutorials/data_pipeline.md)
+- [adding new modules](docs/en/tutorials/new_modules.md)
+- [customizing schedule](docs/en/tutorials/schedule.md)
+- [customizing runtime settings](docs/en/tutorials/runtime.md)
 
-Colab tutorials are also provided. To learn about MMClassification Python API, you may preview the notebook [here](https://github.com/open-mmlab/mmclassification/blob/master/docs/tutorials/MMClassification_python.ipynb) or directly [run](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs/tutorials/MMClassification_python.ipynb) on Colab.
-To learn about MMClassification shell tools, you may preview the notebook [here](https://github.com/open-mmlab/mmclassification/blob/master/docs/tutorials/MMClassification_tools.ipynb) or directly [run](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs/tutorials/MMClassification_tools.ipynb) on Colab.
+Colab tutorials are also provided. To learn about MMClassification Python API, you may preview the notebook [here](https://github.com/open-mmlab/mmclassification/blob/master/docs/en/tutorials/MMClassification_python.ipynb) or directly [run](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs/en/tutorials/MMClassification_python.ipynb) on Colab.
+To learn about MMClassification shell tools, you may preview the notebook [here](https://github.com/open-mmlab/mmclassification/blob/master/docs/en/tutorials/MMClassification_tools.ipynb) or directly [run](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs/en/tutorials/MMClassification_tools.ipynb) on Colab.
 
 ## Citation
 
@@ -106,7 +106,7 @@ If you find this project useful in your research, please consider cite:
 ## Contributing
 
 We appreciate all contributions to improve MMClassification.
-Please refer to [CONTRUBUTING.md](docs/community/CONTRIBUTING.md) for the contributing guideline.
+Please refer to [CONTRUBUTING.md](docs/en/community/CONTRIBUTING.md) for the contributing guideline.
 
 ## Acknowledgement
 

README_zh-CN.md

@@ -43,11 +43,11 @@ MMClassification 是一款基于 PyTorch 的开源图像分类工具箱，是 [O
 - 支持了 **ImageNet21k** 数据集
 - 添加了一个**可视化数据预处理**的工具，可以参考[教程](https://mmclassification.readthedocs.io/zh_CN/latest/tools/visualization.html#id2)使用
 
-发布历史和更新细节请参考 [更新日志](docs/changelog.md)
+发布历史和更新细节请参考 [更新日志](docs/en/changelog.md)
 
 ## 基准测试及模型库
 
-相关结果和模型可在 [model zoo](docs/model_zoo.md) 中获得
+相关结果和模型可在 [model zoo](docs/en/model_zoo.md) 中获得
 
 支持的主干网络：
 
@@ -73,25 +73,25 @@ MMClassification 是一款基于 PyTorch 的开源图像分类工具箱，是 [O
 
 ## 安装
 
-请参考 [安装指南](docs_zh-CN/install.md) 进行安装
+请参考 [安装指南](docs/zh_CN/install.md) 进行安装
 
 ## 基础教程
 
-请参考 [基础教程](docs_zh-CN/getting_started.md) 来了解 MMClassification 的基本使用。MMClassification 也提供了其他更详细的教程:
+请参考 [基础教程](docs/zh_CN/getting_started.md) 来了解 MMClassification 的基本使用。MMClassification 也提供了其他更详细的教程:
 
-- [如何编写配置文件](docs_zh-CN/tutorials/config.md)
-- [如何微调模型](docs_zh-CN/tutorials/finetune.md)
-- [如何增加新数据集](docs_zh-CN/tutorials/new_dataset.md)
-- [如何设计数据处理流程](/docs_zh-CN/tutorials/data_pipeline.md)
-- [如何增加新模块](docs_zh-CN/tutorials/new_modules.md)
-- [如何自定义优化策略](tutorials/schedule.md)
-- [如何自定义运行参数](tutorials/runtime.md)
+- [如何编写配置文件](docs/zh_CN/tutorials/config.md)
+- [如何微调模型](docs/zh_CN/tutorials/finetune.md)
+- [如何增加新数据集](docs/zh_CN/tutorials/new_dataset.md)
+- [如何设计数据处理流程](/docs/zh_CN/tutorials/data_pipeline.md)
+- [如何增加新模块](docs/zh_CN/tutorials/new_modules.md)
+- [如何自定义优化策略](docs/zh_CN/tutorials/schedule.md)
+- [如何自定义运行参数](docs/zh_CN/tutorials/runtime.md)
 
-MMClassification 也提供了相应的中文 Colab 教程。了解 MMClassification Python API，可以查看 [这里](https://github.com/open-mmlab/mmclassification/blob/master/docs_zh-CN/tutorials/MMClassification_python_cn.ipynb) 或者直接在 Colab 上 [运行](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs_zh-CN/tutorials/MMClassification_python_cn.ipynb)。了解 MMClassification 命令行工具，可以查看 [这里](https://github.com/open-mmlab/mmclassification/blob/master/docs_zh-CN/tutorials/MMClassification_tools_cn.ipynb) 或者直接在 Colab 上 [运行](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs_zh-CN/tutorials/MMClassification_tools_cn.ipynb)。
+MMClassification 也提供了相应的中文 Colab 教程。了解 MMClassification Python API，可以查看 [这里](https://github.com/open-mmlab/mmclassification/blob/master/docs/zh_CN/tutorials/MMClassification_python_cn.ipynb) 或者直接在 Colab 上 [运行](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs/zh_CN/tutorials/MMClassification_python_cn.ipynb)。了解 MMClassification 命令行工具，可以查看 [这里](https://github.com/open-mmlab/mmclassification/blob/master/docs/zh_CN/tutorials/MMClassification_tools_cn.ipynb) 或者直接在 Colab 上 [运行](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs/zh_CN/tutorials/MMClassification_tools_cn.ipynb)。
 
 ## 参与贡献
 
-我们非常欢迎任何有助于提升 MMClassification 的贡献，请参考 [贡献指南](docs_zh-CN/community/CONTRIBUTING.md) 来了解如何参与贡献。
+我们非常欢迎任何有助于提升 MMClassification 的贡献，请参考 [贡献指南](docs/zh_CN/community/CONTRIBUTING.md) 来了解如何参与贡献。
 
 ## 致谢
 
@@ -121,7 +121,7 @@ MMClassification 是一款由不同学校和公司共同贡献的开源项目。
 扫描下方的二维码可关注 OpenMMLab 团队的 [知乎官方账号](https://www.zhihu.com/people/openmmlab)，加入 OpenMMLab 团队的 [官方交流 QQ 群](https://jq.qq.com/?_wv=1027&k=GJP18SjI)
 
 <div align="center">
-<img src="/docs/imgs/zhihu_qrcode.jpg" height="400" />  <img src="/docs/imgs/qq_group_qrcode.jpg" height="400" />
+<img src="/docs/zh_CN/imgs/zhihu_qrcode.jpg" height="400" />  <img src="/docs/zh_CN/imgs/qq_group_qrcode.jpg" height="400" />
 </div>
 
 我们会在 OpenMMLab 社区为大家

docs/en/conf.py

@@ -17,7 +17,7 @@ import sys
 import pytorch_sphinx_theme
 from sphinx.builders.html import StandaloneHTMLBuilder
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../../'))
 
 # -- Project information -----------------------------------------------------
 
@@ -26,7 +26,7 @@ copyright = '2020, OpenMMLab'
 author = 'MMClassification Authors'
 
 # The full version, including alpha/beta/rc tags
-version_file = '../mmcls/version.py'
+version_file = '../../mmcls/version.py'
 
 
 def get_version():
@@ -116,96 +116,10 @@ html_theme_options = {
                 },
             ]
         },
-        {
-            'name':
-            'Docs',
-            'children': [
-                {
-                    'name': 'MMCV',
-                    'url': 'https://mmcv.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MIM',
-                    'url': 'https://openmim.readthedocs.io/en/latest/'
-                },
-                {
-                    'name': 'MMAction2',
-                    'url': 'https://mmaction2.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MMClassification',
-                    'url':
-                    'https://mmclassification.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MMDetection',
-                    'url': 'https://mmdetection.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MMDetection3D',
-                    'url': 'https://mmdetection3d.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MMEditing',
-                    'url': 'https://mmediting.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MMGeneration',
-                    'url': 'https://mmgeneration.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MMOCR',
-                    'url': 'https://mmocr.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MMPose',
-                    'url': 'https://mmpose.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MMSegmentation',
-                    'url': 'https://mmsegmentation.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MMTracking',
-                    'url': 'https://mmtracking.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MMFlow',
-                    'url': 'https://mmflow.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MMFewShot',
-                    'url': 'https://mmfewshot.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MMHuman3d',
-                    'url': 'https://mmhuman3d.readthedocs.io/en/latest/',
-                },
-            ]
-        },
-        {
-            'name':
-            'OpenMMLab',
-            'children': [
-                {
-                    'name': 'Homepage',
-                    'url': 'https://openmmlab.com/'
-                },
-                {
-                    'name': 'GitHub',
-                    'url': 'https://github.com/open-mmlab/'
-                },
-                {
-                    'name': 'Twitter',
-                    'url': 'https://twitter.com/OpenMMLab'
-                },
-                {
-                    'name': 'Zhihu',
-                    'url': 'https://zhihu.com/people/openmmlab'
-                },
-            ]
-        },
-    ]
+    ],
+    # Specify the language of shared menu
+    'menu_lang':
+    'en'
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

docs/en/stat.py

@@ -12,7 +12,7 @@ url_prefix = 'https://github.com/open-mmlab/mmclassification/blob/master/'
 
 papers_root = Path('papers')
 papers_root.mkdir(exist_ok=True)
-files = [Path(f) for f in sorted(glob.glob('../configs/*/README.md'))]
+files = [Path(f) for f in sorted(glob.glob('../../configs/*/README.md'))]
 
 stats = []
 titles = []

docs/zh_CN/conf.py

@@ -17,7 +17,7 @@ import sys
 import pytorch_sphinx_theme
 from sphinx.builders.html import StandaloneHTMLBuilder
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../..'))
 
 # -- Project information -----------------------------------------------------
 
@@ -26,7 +26,7 @@ copyright = '2020, OpenMMLab'
 author = 'MMClassification Authors'
 
 # The full version, including alpha/beta/rc tags
-version_file = '../mmcls/version.py'
+version_file = '../../mmcls/version.py'
 
 
 def get_version():
@@ -116,98 +116,10 @@ html_theme_options = {
                 },
             ]
         },
-        {
-            'name':
-            '文档',
-            'children': [
-                {
-                    'name': 'MMCV',
-                    'url': 'https://mmcv.readthedocs.io/zh_CN/latest/',
-                },
-                {
-                    'name': 'MIM',
-                    'url': 'https://openmim.readthedocs.io/en/latest/'
-                },
-                {
-                    'name': 'MMAction2',
-                    'url': 'https://mmaction2.readthedocs.io/zh_CN/latest/',
-                },
-                {
-                    'name': 'MMClassification',
-                    'url':
-                    'https://mmclassification.readthedocs.io/zh_CN/latest/',
-                },
-                {
-                    'name': 'MMDetection',
-                    'url': 'https://mmdetection.readthedocs.io/zh_CN/latest/',
-                },
-                {
-                    'name': 'MMDetection3D',
-                    'url':
-                    'https://mmdetection3d.readthedocs.io/zh_CN/latest/',
-                },
-                {
-                    'name': 'MMEditing',
-                    'url': 'https://mmediting.readthedocs.io/zh_CN/latest/',
-                },
-                {
-                    'name': 'MMGeneration',
-                    'url': 'https://mmgeneration.readthedocs.io/zh_CN/latest/',
-                },
-                {
-                    'name': 'MMOCR',
-                    'url': 'https://mmocr.readthedocs.io/zh_CN/latest/',
-                },
-                {
-                    'name': 'MMPose',
-                    'url': 'https://mmpose.readthedocs.io/zh_CN/latest/',
-                },
-                {
-                    'name': 'MMSegmentation',
-                    'url':
-                    'https://mmsegmentation.readthedocs.io/zh_CN/latest/',
-                },
-                {
-                    'name': 'MMTracking',
-                    'url': 'https://mmtracking.readthedocs.io/zh_CN/latest/',
-                },
-                {
-                    'name': 'MMFlow',
-                    'url': 'https://mmflow.readthedocs.io/en/latest/',
-                },
-                {
-                    'name': 'MMFewShot',
-                    'url': 'https://mmfewshot.readthedocs.io/zh_CN/latest/',
-                },
-                {
-                    'name': 'MMHuman3d',
-                    'url': 'https://mmhuman3d.readthedocs.io/en/latest/',
-                },
-            ]
-        },
-        {
-            'name':
-            'OpenMMLab',
-            'children': [
-                {
-                    'name': '官网',
-                    'url': 'https://openmmlab.com/'
-                },
-                {
-                    'name': 'GitHub',
-                    'url': 'https://github.com/open-mmlab/'
-                },
-                {
-                    'name': '推特',
-                    'url': 'https://twitter.com/OpenMMLab'
-                },
-                {
-                    'name': '知乎',
-                    'url': 'https://zhihu.com/people/openmmlab'
-                },
-            ]
-        },
-    ]
+    ],
+    # Specify the language of shared menu
+    'menu_lang':
+    'cn',
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

docs/zh_CN/model_zoo.md

@@ -0,0 +1 @@
+../en/model_zoo.md

docs/zh_CN/stat.py

@@ -12,7 +12,7 @@ url_prefix = 'https://github.com/open-mmlab/mmclassification/blob/master/'
 
 papers_root = Path('papers')
 papers_root.mkdir(exist_ok=True)
-files = [Path(f) for f in sorted(glob.glob('../configs/*/README.md'))]
+files = [Path(f) for f in sorted(glob.glob('../../configs/*/README.md'))]
 
 stats = []
 titles = []

docs_zh-CN/model_zoo.md

@@ -1 +0,0 @@
-../docs/model_zoo.md