Hbsun/demo doc (#168)

* move demo.md to demo/docs

* update link in md

.gitignore

@@ -136,3 +136,4 @@ htmlcov
 log.txt
 workspace.code-workspace
 results
+mmocr/core/font.TTF

demo/README.md

@@ -2,28 +2,28 @@
 
 This page provides tutorials about running demos. Please click the link below for more information.
 
-Please refer to [Text Detection](../docs/text_det_demo.md) for the tutorial of Text Detection demo.
+Please refer to [Text Detection](docs/text_det_demo.md) for the tutorial of Text Detection demo.
 
 <div align="center">
-    <img src="../resources/demo_text_det_pred.jpg"/><br>
+    <img src="/resources/demo_text_det_pred.jpg"/><br>
 
 </div>
 <br>
 <br>
 
-Please refer to [Text Recognition](../docs/text_recog_demo.md) for the tutorial of Text Recognition demo.
+Please refer to [Text Recognition](docs/text_recog_demo.md) for the tutorial of Text Recognition demo.
 
 <div align="center">
-    <img src="../resources/demo_text_recog_pred.jpg" width="200px" alt/><br>
+    <img src="/resources/demo_text_recog_pred.jpg" width="200px" alt/><br>
 
 </div>
 <br>
 <br>
 
-Please refer to [End2End Demo](../docs/ocr_demo.md) for the tutorial of Text Detection and Recognition end-to-end demo.
+Please refer to [End2End Demo](docs/ocr_demo.md) for the tutorial of Text Detection and Recognition end-to-end demo.
 
 <div align="center">
-    <img src="../resources/demo_ocr_pred.jpg"/><br>
+    <img src="/resources/demo_ocr_pred.jpg"/><br>
 
 </div>
 

demo/docs/ocr_demo.md

@@ -1,5 +1,10 @@
 ## OCR End2End Demo
 
+<div align="center">
+    <img src="/resources/demo_ocr_pred.jpg"/><br>
+
+</div>
+
 ### End-to-End Test Image Demo
 
 To end-to-end test a single image with text detection and recognition simutaneously:
@@ -8,7 +13,7 @@ To end-to-end test a single image with text detection and recognition simutaneou
 python demo/ocr_image_demo.py demo/demo_text_det.jpg demo/output.jpg
 ```
 
-- The default config for text detection and recognition are [PSENet_ICDAR2015](../configs/textdet/psenet/psenet_r50_fpnf_600e_icdar2015.py) and [SAR](../configs/textrecog/sar/sar_r31_parallel_decoder_academic.py), respectively.
+- The default config for text detection and recognition are [PSENet_ICDAR2015](/configs/textdet/psenet/psenet_r50_fpnf_600e_icdar2015.py) and [SAR](/configs/textrecog/sar/sar_r31_parallel_decoder_academic.py), respectively.
 
 - The predicted result will be saved as `demo/output.jpg`.
 - To use other algorithms of text detection and recognition, please set arguments: `--det-config`, `--det-ckpt`, `--recog-config`, `--recog-ckpt`.

demo/docs/text_det_demo.md

@@ -1,13 +1,18 @@
 ## Text Detection Demo
 
+<div align="center">
+    <img src="/resources/demo_text_det_pred.jpg"/><br>
+
+</div>
+
 ### Text Detection Image Demo
 
 
-We provide a demo script to test a [single image](../demo/demo_text_det.jpg) for text detection with a single GPU.
+We provide a demo script to test a [single image](/demo/demo_text_det.jpg) for text detection with a single GPU.
 
 *Text Detection Model Preparation:*
 The pre-trained text detection model can be downloaded from [model zoo](https://mmocr.readthedocs.io/en/latest/modelzoo.html).
-Take [PANet](../configs/textdet/panet/panet_r18_fpem_ffm_600e_icdar2015.py) as an example:
+Take [PANet](/configs/textdet/panet/panet_r18_fpem_ffm_600e_icdar2015.py) as an example:
 
 ```shell
 python demo/image_demo.py ${TEST_IMG} ${CONFIG_FILE} ${CHECKPOINT_FILE} ${SAVE_PATH} [--imshow] [--device ${GPU_ID}]

demo/docs/text_recog_demo.md

@@ -1,13 +1,18 @@
 ## Text Recognition Demo
 
+<div align="center">
+    <img src="/resources/demo_text_recog_pred.jpg" width="200px" alt/><br>
+
+</div>
+
 ### Text Recognition Image Demo
 
 
-We provide a demo script to test a [single demo image](../demo/demo_text_recog.jpg) for text recognition with a single GPU.
+We provide a demo script to test a [single demo image](/demo/demo_text_recog.jpg) for text recognition with a single GPU.
 
 *Text Recognition Model Preparation:*
 The pre-trained text recognition model can be downloaded from [model zoo](https://mmocr.readthedocs.io/en/latest/modelzoo.html).
-Take [SAR](../configs/textrecog/sar/sar_r31_parallel_decoder_academic.py) as an example:
+Take [SAR](/configs/textrecog/sar/sar_r31_parallel_decoder_academic.py) as an example:
 
 ```shell
 python demo/image_demo.py ${TEST_IMG} ${CONFIG_FILE} ${CHECKPOINT_FILE} ${SAVE_PATH} [--imshow] [--device ${GPU_ID}]

docs/index.rst

@@ -1,6 +1,12 @@
 Welcome to MMOCR's documentation!
 =======================================
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Demo
+
+   demo.md
+
 .. toctree::
    :maxdepth: 2
    :caption: Get Started

docs/merge_docs.sh

@@ -8,3 +8,4 @@ sed -i '$a\\n' ../configs/textrecog/*/*.md
 cat ../configs/kie/*/*.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# Key Information Extraction Models' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmocr/tree/master/=g' >kie_models.md
 cat ../configs/textdet/*/*.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# Text Detection Models' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmocr/tree/master/=g' >textdet_models.md
 cat ../configs/textrecog/*/*.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# Text Recognition Models' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmocr/tree/master/=g' >textrecog_models.md
+cat ../demo/docs/*_demo.md | sed "s/#/#&/" | sed "s/md###t/html#t/g" | sed '1i\# Demo' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmocr/tree/master/=g' >demo.md