[Docs] Build Chinese docs (#1073)

* Remove _build directroy in docs_zh_CN

* Change utils title to Chinese

* Translate documents

* Translate documents

* Use symbolic link to avoid repeated images

* Use symbolic link to avoid repeated images

* fix readme.md

* update copyright

* refactor docs

* rename title to Chinese

.gitignore

@@ -65,6 +65,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs_zh_CN/_build/
 
 # PyBuilder
 target/

docs/conf.py

@@ -27,8 +27,8 @@ __version__ = locals()['__version__']
 # -- Project information -----------------------------------------------------
 
 project = 'mmcv'
-copyright = '2018-2019, Kai Chen'
-author = 'Kai Chen'
+copyright = '2018-2021, OpenMMLab'
+author = 'MMCV Authors'
 
 # The short X.Y version
 version = __version__

docs/index.rst

 Welcome to MMCV's documentation!
 ================================
 
+You can switch between Chinese and English documents in the lower-left corner of the layout.
+
 .. toctree::
    :maxdepth: 2
 

docs/understand_mmcv/data_process.md

@@ -13,7 +13,7 @@ import mmcv
 
 img = mmcv.imread('test.jpg')
 img = mmcv.imread('test.jpg', flag='grayscale')
-img_ = mmcv.imread(img) # nothing will happen, img_ = img
+img_ = mmcv.imread(img)  # nothing will happen, img_ = img
 mmcv.imwrite(img, 'out.jpg')
 ```
 

docs/understand_mmcv/io.md

@@ -105,7 +105,7 @@ Then use `list_from_file` to load the list from a.txt.
 ['/mnt/a', '/mnt/b', '/mnt/c', '/mnt/d', '/mnt/e']
 ```
 
-For example `b.txt` is a text file with 5 lines.
+For example `b.txt` is a text file with 3 lines.
 
 ```
 1 cat
@@ -113,7 +113,7 @@ For example `b.txt` is a text file with 5 lines.
 3 panda
 ```
 
-Then use `dict_from_file` to load the list from a.txt.
+Then use `dict_from_file` to load the dict from `b.txt` .
 
 ```python
 >>> mmcv.dict_from_file('b.txt')

docs_zh_CN/Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+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)

docs_zh_CN/_static

+../docs/_static
\ No newline at end of file

docs_zh_CN/api.rst

+API 文档
+=========
+
+
+fileio
+-------
+.. automodule:: mmcv.fileio
+    :members:
+
+image
+------
+.. automodule:: mmcv.image
+    :members:
+
+video
+------
+.. automodule:: mmcv.video
+    :members:
+
+arraymisc
+---------
+.. automodule:: mmcv.arraymisc
+    :members:
+
+visualization
+--------------
+.. automodule:: mmcv.visualization
+    :members:
+
+utils
+-----
+.. automodule:: mmcv.utils
+    :members:
+
+cnn
+----
+.. automodule:: mmcv.cnn
+    :members:
+
+runner
+------
+.. automodule:: mmcv.runner
+    :members:
+
+ops
+------
+.. automodule:: mmcv.ops
+    :members:

docs_zh_CN/community.rst

+社区
+===========
+
+.. toctree::
+   :maxdepth: 2
+
+   community/contributing.md

docs_zh_CN/community/contributing.md

+## 贡献代码
+
+欢迎有兴趣的朋友一起翻译 MMCV 文档。如有兴趣，请在 [MMCV issue](https://github.com/open-mmlab/mmcv/issues) 提 issue 确定翻译的文档。

docs_zh_CN/conf.py

+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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 sys
+
+from m2r import MdInclude
+from recommonmark.transform import AutoStructify
+
+sys.path.insert(0, os.path.abspath('..'))
+
+version_file = '../mmcv/version.py'
+with open(version_file, 'r') as f:
+    exec(compile(f.read(), version_file, 'exec'))
+__version__ = locals()['__version__']
+
+# -- Project information -----------------------------------------------------
+
+project = 'mmcv'
+copyright = '2018-2021, OpenMMLab'
+author = 'MMCV Authors'
+
+# The short X.Y version
+version = __version__
+# The full version, including alpha/beta/rc tags
+release = __version__
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# 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.ext.autosectionlabel',
+    'sphinx_markdown_tables'
+]  # yapf: disable
+
+autodoc_mock_imports = ['mmcv._ext', 'mmcv.utils.ext_loader', 'torchvision']
+autosectionlabel_prefix_document = True
+
+# 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'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'zh_CN'
+
+# 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']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- 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'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'mmcvdoc'
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'mmcv.tex', 'mmcv Documentation', 'Kai Chen', 'manual'),
+]
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, 'mmcv', 'mmcv Documentation', [author], 1)]
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'mmcv', 'mmcv Documentation', author, 'mmcv',
+     'One line description of project.', 'Miscellaneous'),
+]
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# -- Extension configuration -------------------------------------------------
+
+
+def setup(app):
+    app.add_config_value('no_underscore_emphasis', False, 'env')
+    app.add_config_value('m2r_parse_relative_links', False, 'env')
+    app.add_config_value('m2r_anonymous_references', False, 'env')
+    app.add_config_value('m2r_disable_inline_math', False, 'env')
+    app.add_directive('mdinclude', MdInclude)
+    app.add_config_value('recommonmark_config', {
+        'auto_toc_tree_section': 'Contents',
+        'enable_eval_rst': True,
+    }, True)
+    app.add_transform(AutoStructify)

docs_zh_CN/deployment.rst

+部署
+========
+
+.. toctree::
+    :maxdepth: 2
+
+    deployment/onnx.md
+    deployment/onnxruntime_op.md
+    deployment/onnxruntime_custom_ops.md
+    deployment/tensorrt_plugin.md
+    deployment/tensorrt_custom_ops.md

docs_zh_CN/deployment/onnx.md

+# MMCV 中的 onnx 模块 (实验性质)
+
+欢迎有兴趣的朋友一起翻译 MMCV 文档。如有兴趣，请在 [MMCV issue](https://github.com/open-mmlab/mmcv/issues) 提 issue 确定翻译的文档。

docs_zh_CN/deployment/onnxruntime_custom_ops.md

+# Onnxruntime 自定义算子
+
+欢迎有兴趣的朋友一起翻译 MMCV 文档。如有兴趣，请在 [MMCV issue](https://github.com/open-mmlab/mmcv/issues) 提 issue 确定翻译的文档。

docs_zh_CN/deployment/onnxruntime_op.md

+# MMCV 中用于 ONNX Runtime 的自定义算子
+
+欢迎有兴趣的朋友一起翻译 MMCV 文档。如有兴趣，请在 [MMCV issue](https://github.com/open-mmlab/mmcv/issues) 提 issue 确定翻译的文档。

docs_zh_CN/deployment/tensorrt_custom_ops.md

+# TensorRT 自定义算子
+
+欢迎有兴趣的朋友一起翻译 MMCV 文档。如有兴趣，请在 [MMCV issue](https://github.com/open-mmlab/mmcv/issues) 提 issue 确定翻译的文档。

docs_zh_CN/deployment/tensorrt_plugin.md

+# MMCV 中用于自定义算子的 TensorRT 插件 (实验性质)
+
+欢迎有兴趣的朋友一起翻译 MMCV 文档。如有兴趣，请在 [MMCV issue](https://github.com/open-mmlab/mmcv/issues) 提 issue 确定翻译的文档。

docs_zh_CN/faq.md

+## 常见问题
+
+欢迎有兴趣的朋友一起翻译 MMCV 文档。如有兴趣，请在 [MMCV issue](https://github.com/open-mmlab/mmcv/issues) 提 issue 确定翻译的文档。

docs_zh_CN/get_started.rst

+介绍及安装
+===================
+
+.. toctree::
+    :maxdepth: 2
+
+    get_started/introduction.md
+    get_started/installation.md
+    get_started/build.md

docs_zh_CN/get_started/build.md

+## 从源码编译 MMCV
+
+欢迎有兴趣的朋友一起翻译 MMCV 文档。如有兴趣，请在 [MMCV issue](https://github.com/open-mmlab/mmcv/issues) 提 issue 确定翻译的文档。