open-mmlab · ZwwWayne · Jul 8, 2021 · Jun 9, 2021 · Jun 22, 2021 · Jun 22, 2021
diff --git a/README.md b/README.md
@@ -42,11 +42,11 @@ Apart from MMDetection, we also released a library [mmcv](https://github.com/ope
 
 This project is released under the [Apache 2.0 license](LICENSE).
 
-## Changelog
+## News
 
-v2.13.0 was released in 01/06/2021.
-Please refer to [changelog.md](docs/changelog.md) for details and release history.
-A comparison between v1.x and v2.0 codebases can be found in [compatibility.md](docs/compatibility.md).
+Nowadays, We are making Chinese documents and Chinese tutorials for MMDetection. They are all based on [English documents](docs/), the framework of the Chinses documents is at [here](docs_zh-CN/). It is very welecome everyone to translate English documents into Chinese. Please refer to [CONTRIBUTING.md](https://github.com/open-mmlab/mmdetection/blob/master/.github/CONTRIBUTING.md) for more details about the contributing guideline. Hope you can contribute to MMdetection
+
+**NOTE: ** The Chinese is in `doc_zh` branch, please submit to this branch when you create your PR. To avoid repeated submissions, please check [PR](https://github.com/open-mmlab/mmdetection/pulls/) in advance to see if anyone has already submitted the corresponding Chinese documents.
 
 ## Benchmark and model zoo
 

diff --git a/README_zh-CN.md b/README_zh-CN.md
@@ -42,11 +42,11 @@ v1.x 的历史版本支持 PyTorch 1.1 到 1.4，但是我们强烈建议用户
 
 该项目采用 [Apache 2.0 开源许可证](LICENSE)。
 
-## 更新日志
+## 新闻
 
-最新的月度版本 v2.13.0 在 2021.06.01 发布。
-如果想了解更多版本更新细节和历史信息，请阅读[更新日志](docs/changelog.md)。
-在[兼容性说明文档](docs/compatibility.md)中我们提供了 1.x 和 2.0 版本的详细比较。
+我们正在制作 MMDetection 的中文文档和中文教程，他们都是基于[英文文档](docs/)进行翻译的，文档的框架已经做好并放在了[这里](docs_zh-CN/)，欢迎大家将英文文档翻译成中文，具体的提交要求请参考[这里](https://openmmlab.feishu.cn/docs/doccnhOhfcRrgD8aAvrVfs6DuOe)，希望你也能为 MMDetection 做出贡献。
+
+注意：中文文档的框架只出现在 `doc_zh` 分支，请提交的时候也提交到该分支。为避免重复提交，请提前查看 [PR](https://github.com/open-mmlab/mmdetection/pulls/) 中是否已经有人提交了相应的中文文档。
 
 ## 基准测试和模型库
 

diff --git a/docs/api.rst b/docs/api.rst
@@ -39,11 +39,6 @@ post_processing
 .. automodule:: mmdet.core.post_processing
     :members:
 
-optimizer
-^^^^^^^^^^
-.. automodule:: mmdet.core.optimizer
-    :members:
-
 utils
 ^^^^^^^^^^
 .. automodule:: mmdet.core.utils
@@ -62,6 +57,16 @@ pipelines
 .. automodule:: mmdet.datasets.pipelines
     :members:
 
+samplers
+^^^^^^^^^^
+.. automodule:: mmdet.datasets.samplers
+    :members:
+
+api_wrappers
+^^^^^^^^^^
+.. automodule:: mmdet.datasets.api_wrappers
+    :members:
+
 mmdet.models
 --------------
 
@@ -99,3 +104,8 @@ utils
 ^^^^^^^^^^
 .. automodule:: mmdet.models.utils
     :members:
+
+mmdet.utils
+--------------
+.. automodule::mmdet.utils
+    :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -19,7 +19,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'MMDetection'
-copyright = '2018-2020, OpenMMLab'
+copyright = '2018-2021, OpenMMLab'
 author = 'MMDetection Authors'
 version_file = '../mmdet/version.py'
 

diff --git a/docs/faq.md b/docs/faq.md
@@ -1,3 +1,5 @@
+# Frequently Asked Questions
+
 We list some common troubles faced by many users and their corresponding solutions here. Feel free to enrich the list if you find any frequent issues and have ways to help others to solve them. If the contents here do not cover your issue, please create an issue using the [provided templates](https://github.com/open-mmlab/mmdetection/blob/master/.github/ISSUE_TEMPLATE/error-report.md/) and make sure you fill in all required information in the template.
 
 ## MMCV Installation

diff --git a/docs/index.rst b/docs/index.rst
@@ -15,6 +15,7 @@ Welcome to MMDetection's documentation!
 
    1_exist_data_model.md
    2_new_data_model.md
+   3_exist_data_new_model.md
 
 .. toctree::
    :maxdepth: 2
@@ -38,6 +39,11 @@ Welcome to MMDetection's documentation!
    changelog.md
    faq.md
 
+.. toctree::
+   :caption: Switch Language
+
+   switch_language.md
+
 .. toctree::
    :caption: API Reference
 

diff --git a/docs/model_zoo.md b/docs/model_zoo.md
@@ -2,8 +2,7 @@
 
 ## Mirror sites
 
-We use AWS as the main site to host our model zoo, and maintain a mirror on aliyun.
-You can replace `https://s3.ap-northeast-2.amazonaws.com/open-mmlab` with `https://open-mmlab.oss-cn-beijing.aliyuncs.com` in model urls.
+We only use aliyun to maintain the model zoo since MMDetection V2.0. The model zoo of V1.x remains in AWS and will be deprecated in the future.
 
 ## Common settings
 

diff --git a/docs/switch_language.md b/docs/switch_language.md
@@ -0,0 +1,3 @@
+## <a href='https://mmdetection.readthedocs.io/en/latest/'>English</a>
+
+## <a href='https://mmdetection.readthedocs.io/zh_CN/latest/'>简体中文</a>
diff --git a/docs_zh-CN/1_exist_data_model.md b/docs_zh-CN/1_exist_data_model.md
@@ -0,0 +1 @@
+# 1: 使用已有模型在标准数据集上进行推理
diff --git a/docs_zh-CN/2_new_data_model.md b/docs_zh-CN/2_new_data_model.md
@@ -0,0 +1 @@
+# 2: 在自定义数据集上进行训练
diff --git a/docs_zh-CN/3_exist_data_new_model.md b/docs_zh-CN/3_exist_data_new_model.md
@@ -0,0 +1 @@
+# 3: 在标准数据集上训练自定义模型
diff --git a/docs_zh-CN/Makefile b/docs_zh-CN/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs_zh-CN/api.rst b/docs_zh-CN/api.rst
@@ -0,0 +1,111 @@
+API Reference
+=================
+
+mmdet.apis
+--------------
+.. automodule:: mmdet.apis
+    :members:
+
+mmdet.core
+--------------
+
+anchor
+^^^^^^^^^^
+.. automodule:: mmdet.core.anchor
+    :members:
+
+bbox
+^^^^^^^^^^
+.. automodule:: mmdet.core.bbox
+    :members:
+
+export
+^^^^^^^^^^
+.. automodule:: mmdet.core.export
+    :members:
+
+mask
+^^^^^^^^^^
+.. automodule:: mmdet.core.mask
+    :members:
+
+evaluation
+^^^^^^^^^^
+.. automodule:: mmdet.core.evaluation
+    :members:
+
+post_processing
+^^^^^^^^^^^^^^^
+.. automodule:: mmdet.core.post_processing
+    :members:
+
+utils
+^^^^^^^^^^
+.. automodule:: mmdet.core.utils
+    :members:
+
+mmdet.datasets
+--------------
+
+datasets
+^^^^^^^^^^
+.. automodule:: mmdet.datasets
+    :members:
+
+pipelines
+^^^^^^^^^^
+.. automodule:: mmdet.datasets.pipelines
+    :members:
+
+samplers
+^^^^^^^^^^
+.. automodule:: mmdet.datasets.samplers
+    :members:
+
+api_wrappers
+^^^^^^^^^^
+.. automodule:: mmdet.datasets.api_wrappers
+    :members:
+
+mmdet.models
+--------------
+
+detectors
+^^^^^^^^^^
+.. automodule:: mmdet.models.detectors
+    :members:
+
+backbones
+^^^^^^^^^^
+.. automodule:: mmdet.models.backbones
+    :members:
+
+necks
+^^^^^^^^^^^^
+.. automodule:: mmdet.models.necks
+    :members:
+
+dense_heads
+^^^^^^^^^^^^
+.. automodule:: mmdet.models.dense_heads
+    :members:
+
+roi_heads
+^^^^^^^^^^
+.. automodule:: mmdet.models.roi_heads
+    :members:
+
+losses
+^^^^^^^^^^
+.. automodule:: mmdet.models.losses
+    :members:
+
+utils
+^^^^^^^^^^
+.. automodule:: mmdet.models.utils
+    :members:
+
+mmdet.utils
+--------------
+.. automodule::mmdet.utils
+    :members:
diff --git a/docs_zh-CN/compatibility.md b/docs_zh-CN/compatibility.md
@@ -0,0 +1 @@
+# 兼容性说明
diff --git a/docs_zh-CN/conf.py b/docs_zh-CN/conf.py
@@ -0,0 +1,92 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import subprocess
+import sys
+
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- Project information -----------------------------------------------------
+
+project = 'MMDetection'
+copyright = '2018-2021, OpenMMLab'
+author = 'MMDetection Authors'
+version_file = '../mmdet/version.py'
+
+
+def get_version():
+    with open(version_file, 'r') as f:
+        exec(compile(f.read(), version_file, 'exec'))
+    return locals()['__version__']
+
+
+# The full version, including alpha/beta/rc tags
+release = get_version()
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
+    'recommonmark',
+    'sphinx_markdown_tables',
+]
+
+autodoc_mock_imports = [
+    'matplotlib', 'pycocotools', 'terminaltables', 'mmdet.version', 'mmcv.ops'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+# The master toctree document.
+master_doc = 'index'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+language = 'zh_CN'
+
+
+def builder_inited_handler(app):
+    subprocess.run(['./stat.py'])
+
+
+def setup(app):
+    app.connect('builder-inited', builder_inited_handler)
diff --git a/docs_zh-CN/conventions.md b/docs_zh-CN/conventions.md
@@ -0,0 +1 @@
+# 默认约定
diff --git a/docs_zh-CN/faq.md b/docs_zh-CN/faq.md
@@ -0,0 +1,3 @@
+# 常见问题解答
+
+中文文档正在建设中，有意向翻译本文档的请提 PR