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

[Docs] Use PyTorch sphinx theme (#1321)

* [Docs] Use PyTorch sphinx theme

* add sphinx-copybutton

* add twitter and zhihu link

* remove shpinx_rtd_theme from doc.xtx

* update docs.txt

* update conf.py
parent 6434d0d7
...@@ -50,13 +50,13 @@ pip install mmcv-full==1.3.9 -f https://download.openmmlab.com/mmcv/dist/cu111/t ...@@ -50,13 +50,13 @@ pip install mmcv-full==1.3.9 -f https://download.openmmlab.com/mmcv/dist/cu111/t
<tbody> <tbody>
<tr> <tr>
<th width="80"> CUDA </th> <th width="80"> CUDA </th>
<th valign="bottom" align="left" width="100">torch 1.9</th> <th valign="bottom" align="left" style="min-width: 100px">torch 1.9</th>
<th valign="bottom" align="left" width="100">torch 1.8</th> <th valign="bottom" align="left" style="min-width: 100px">torch 1.8</th>
<th valign="bottom" align="left" width="100">torch 1.7</th> <th valign="bottom" align="left" style="min-width: 100px">torch 1.7</th>
<th valign="bottom" align="left" width="100">torch 1.6</th> <th valign="bottom" align="left" style="min-width: 100px">torch 1.6</th>
<th valign="bottom" align="left" width="100">torch 1.5</th> <th valign="bottom" align="left" style="min-width: 100px">torch 1.5</th>
<th valign="bottom" align="left" width="100">torch 1.4</th> <th valign="bottom" align="left" style="min-width: 100px">torch 1.4</th>
<th valign="bottom" align="left" width="100">torch 1.3</th> <th valign="bottom" align="left" style="min-width: 100px">torch 1.3</th>
</tr> </tr>
<tr> <tr>
<td align="left">11.1</td> <td align="left">11.1</td>
......
## 介绍 MMCV ## 介绍 MMCV
<div align="center">
<img src="https://raw.githubusercontent.com/open-mmlab/mmcv/master/docs/mmcv-logo.png" width="300"/>
</div>
MMCV 是一个面向计算机视觉的基础库,它支持了很多开源项目,例如: MMCV 是一个面向计算机视觉的基础库,它支持了很多开源项目,例如:
- [MMClassification](https://github.com/open-mmlab/mmclassification): OpenMMLab 图像分类工具箱 - [MMClassification](https://github.com/open-mmlab/mmclassification): OpenMMLab 图像分类工具箱
......
...@@ -4,14 +4,60 @@ ...@@ -4,14 +4,60 @@
您可以在页面左下角切换中英文文档。 您可以在页面左下角切换中英文文档。
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: 介绍与安装
get_started/introduction.md
get_started/installation.md
get_started/build.md
.. toctree::
:maxdepth: 1
:caption: 深入理解 MMCV
understand_mmcv/config.md
understand_mmcv/registry.md
understand_mmcv/runner.md
understand_mmcv/io.md
understand_mmcv/data_process.md
understand_mmcv/visualization.md
understand_mmcv/cnn.md
understand_mmcv/ops.md
understand_mmcv/utils.md
.. toctree::
:maxdepth: 1
:caption: 部署
deployment/onnx.md
deployment/onnxruntime_op.md
deployment/onnxruntime_custom_ops.md
deployment/tensorrt_plugin.md
deployment/tensorrt_custom_ops.md
.. toctree::
:maxdepth: 1
:caption: 兼容性
get_started.rst
understand_mmcv.rst
deployment.rst
compatibility.md compatibility.md
.. toctree::
:maxdepth: 1
:caption: 常见问题
faq.md faq.md
community.rst
.. toctree::
:maxdepth: 1
:caption: 社区
community/contributing.md
community/pr.md
.. toctree::
:maxdepth: 1
:caption: API 文档
api.rst api.rst
......
深入理解 MMCV
=================
.. toctree::
:maxdepth: 2
understand_mmcv/config.md
understand_mmcv/registry.md
understand_mmcv/runner.md
understand_mmcv/io.md
understand_mmcv/data_process.md
understand_mmcv/visualization.md
understand_mmcv/cnn.md
understand_mmcv/ops.md
understand_mmcv/utils.md
...@@ -2,7 +2,8 @@ docutils==0.16.0 ...@@ -2,7 +2,8 @@ docutils==0.16.0
m2r m2r
myst-parser myst-parser
opencv-python opencv-python
-e git+https://github.com/open-mmlab/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme
sphinx==4.0.2 sphinx==4.0.2
sphinx-copybutton
sphinx_markdown_tables sphinx_markdown_tables
sphinx_rtd_theme==0.5.2
torch torch
...@@ -14,6 +14,6 @@ line_length = 79 ...@@ -14,6 +14,6 @@ line_length = 79
multi_line_output = 0 multi_line_output = 0
known_standard_library = pkg_resources,setuptools,logging,os,warnings,abc known_standard_library = pkg_resources,setuptools,logging,os,warnings,abc
known_first_party = mmcv known_first_party = mmcv
known_third_party = addict,cv2,m2r,numpy,onnx,onnxruntime,packaging,pytest,recommonmark,scipy,sphinx,tensorrt,torch,torchvision,yaml,yapf known_third_party = addict,cv2,m2r,numpy,onnx,onnxruntime,packaging,pytest,pytorch_sphinx_theme,recommonmark,scipy,sphinx,tensorrt,torch,torchvision,yaml,yapf
no_lines_before = STDLIB,LOCALFOLDER no_lines_before = STDLIB,LOCALFOLDER
default_section = THIRDPARTY default_section = THIRDPARTY
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