update the documentation for release

README.md

-# mmcv
-Open MMLab Computer Vision Foundation

docs/intro.md → README.rst

-## Introduction
+mmcv
+====
+
+.. image:: https://travis-ci.com/open-mmlab/mmcv.svg?branch=master
+  :target: https://travis-ci.com/open-mmlab/mmcv
+
+.. image:: https://codecov.io/gh/open-mmlab/mmcv/branch/master/graph/badge.svg
+  :target: https://codecov.io/gh/open-mmlab/mmcv
+
+.. image:: 	https://img.shields.io/github/license/open-mmlab/mmcv.svg
+  :target: https://github.com/open-mmlab/mmcv/blob/master/LICENSE
+
+
+Introduction
+------------
 
 `mmcv` is a foundational python library for computer vision research and supports many
-research projects in MMLAB, such as [mmdetection](https://github.com/open-mmlab/mmdetection).
+research projects in MMLAB, such as `mmdetection <https://github.com/open-mmlab/mmdetection>`_.
 
 It provides the following functionalities.
 
@@ -13,21 +27,23 @@ It provides the following functionalities.
 - PyTorch runner with hooking machanism
 - Various CNN architectures
 
-See the [documentation](http://mmcv.readthedocs.io/en/latest) for more features and usage.
+See the `documentation <http://mmcv.readthedocs.io/en/latest>`_ for more features and usage.
 
 
-### Installation
+Installation
+------------
 
 Try and start with
 
-```shell
-pip install mmcv
-```
+.. code::
+
+    pip install mmcv
+
+
+or install from source
 
-If you want to install from source
+.. code::
 
-```shell
-git clone https://github.com/open-mmlab/mmcv.git
-cd mmcv
-pip install .  # (add "-e" if you want to develop or modify the codes)
-```
+    git clone https://github.com/open-mmlab/mmcv.git
+    cd mmcv
+    pip install .  # (add "-e" if you want to develop or modify the codes)

docs/cnn.md

+## CNN
+
+The subpackage `mmcv.cnn` ships with lots of CNN backbones and the number is growing.
+Different from models provided in `torchvision`, these models are designed
+for actual usage in different cases, with highly customizable interfaces.
+
+Taking ResNet as an example, you can specify the following things:
+
+- number of stages
+- stage of output feature maps
+- location of the stride 2 convolutional layer
+- strides and dilation of each stage
+- whether to freeze some first stages
+- whether to fix BN stats
+- whether to fix BN parameters
+- whether to use checkpoint to save memory

docs/index.rst

-Welcome to mmcv's documentation!
-==================================
+.. include:: ../README.rst
+
+Contents
+========
 
 .. toctree::
    :maxdepth: 2
 
-   intro.md
    io.md
    image.md
    video.md
    visualization.md
    utils.md
    runner.md
+   cnn.md
    api.rst
 
 

docs/runner.md

@@ -2,3 +2,5 @@
 
 The runner module aims to help users to start training with less code, while stays
 flexible and configurable.
+
+Documentation and examples are still on going.
\ No newline at end of file