Unverified Commit e4b5348e authored by Zaida Zhou's avatar Zaida Zhou Committed by GitHub
Browse files

[Docs] Refactor the structure of documentation (#1580)

* [Docs] Refactor the structure of documentation

* [Docs] Refactor the structure of documentation

* fix symlink

* fix link

* fix typo

* polish docstring

* fix docstring
parent f31f1cdb
...@@ -38,6 +38,11 @@ runner ...@@ -38,6 +38,11 @@ runner
.. automodule:: mmcv.runner .. automodule:: mmcv.runner
:members: :members:
engine
------
.. automodule:: mmcv.engine
:members:
ops ops
------ ------
.. automodule:: mmcv.ops .. automodule:: mmcv.ops
......
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
+ 当你第一次提 PR 时 + 当你第一次提 PR 时
复刻 OpenMMLab 原代码库,点击 GitHub 页面右上角的 **Fork** 按钮即可 复刻 OpenMMLab 原代码库,点击 GitHub 页面右上角的 **Fork** 按钮即可
![avatar](../../docs/_static/community/1.png) ![avatar](../../en/_static/community/1.png)
克隆复刻的代码库到本地 克隆复刻的代码库到本地
...@@ -73,14 +73,14 @@ git commit -m 'messages' ...@@ -73,14 +73,14 @@ git commit -m 'messages'
``` ```
+ 创建一个`拉取请求` + 创建一个`拉取请求`
![avatar](../../docs/_static/community/2.png) ![avatar](../../en/_static/community/2.png)
+ 修改`拉取请求`信息模板,描述修改原因和修改内容。还可以在 PR 描述中,手动关联到相关的`议题` (issue),(更多细节,请参考[官方文档](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue))。 + 修改`拉取请求`信息模板,描述修改原因和修改内容。还可以在 PR 描述中,手动关联到相关的`议题` (issue),(更多细节,请参考[官方文档](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue))。
#### 5. 讨论并评审你的代码 #### 5. 讨论并评审你的代码
+ 创建`拉取请求`时,可以关联给相关人员进行评审 + 创建`拉取请求`时,可以关联给相关人员进行评审
![avatar](../../docs/_static/community/3.png) ![avatar](../../en/_static/community/3.png)
+ 根据评审人员的意见修改代码,并推送修改 + 根据评审人员的意见修改代码,并推送修改
......
...@@ -17,9 +17,9 @@ import sys ...@@ -17,9 +17,9 @@ import sys
import pytorch_sphinx_theme import pytorch_sphinx_theme
from sphinx.builders.html import StandaloneHTMLBuilder from sphinx.builders.html import StandaloneHTMLBuilder
sys.path.insert(0, os.path.abspath('..')) sys.path.insert(0, os.path.abspath('../..'))
version_file = '../mmcv/version.py' version_file = '../../mmcv/version.py'
with open(version_file, 'r') as f: with open(version_file, 'r') as f:
exec(compile(f.read(), version_file, 'exec')) exec(compile(f.read(), version_file, 'exec'))
__version__ = locals()['__version__'] __version__ = locals()['__version__']
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment