[Docs] Fix API reference & version, support exporting pdf & epub (#406)

* add mmdet

* remove uncessary autodoc mock import

* update docs version

* bind docs version to version.py

* support pdf and epub

* fix readthedocs

.readthedocs.yml

@@ -1,5 +1,7 @@
 version: 2
 
+formats: all
+
 python:
     version: 3.7
     install:

docs/conf.py

@@ -23,7 +23,11 @@
 author = 'OpenMMLab'
 
 # The full version, including alpha/beta/rc tags
-release = '0.1.0'
+version_file = '../mmocr/version.py'
+with open(version_file, 'r') as f:
+    exec(compile(f.read(), version_file, 'exec'))
+__version__ = locals()['__version__']
+release = __version__
 
 # -- General configuration ---------------------------------------------------
 
@@ -38,29 +42,7 @@
     'sphinx_markdown_tables',
 ]
 
-autodoc_mock_imports = [
-    'torch',
-    'torchvision',
-    'mmcv',
-    'mmocr.version',
-    'mmdet',
-    'imgaug',
-    'kwarray',
-    'lmdb',
-    'matplotlib',
-    'Polygon',
-    'cv2',
-    'numpy',
-    'pyclipper',
-    'pycocotools',
-    'pytest',
-    'rapidfuzz',
-    'scipy',
-    'shapely',
-    'skimage',
-    'titlecase',
-    'PIL',
-]
+autodoc_mock_imports = ['mmcv._ext']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs_zh_CN/conf.py

@@ -23,7 +23,11 @@
 author = 'OpenMMLab'
 
 # The full version, including alpha/beta/rc tags
-release = '0.1.0'
+version_file = '../mmocr/version.py'
+with open(version_file, 'r') as f:
+    exec(compile(f.read(), version_file, 'exec'))
+__version__ = locals()['__version__']
+release = __version__
 
 # -- General configuration ---------------------------------------------------
 
@@ -38,29 +42,7 @@
     'sphinx_markdown_tables',
 ]
 
-autodoc_mock_imports = [
-    'torch',
-    'torchvision',
-    'mmcv',
-    'mmocr.version',
-    'mmdet',
-    'imgaug',
-    'kwarray',
-    'lmdb',
-    'matplotlib',
-    'Polygon',
-    'cv2',
-    'numpy',
-    'pyclipper',
-    'pycocotools',
-    'pytest',
-    'rapidfuzz',
-    'scipy',
-    'shapely',
-    'skimage',
-    'titlecase',
-    'PIL',
-]
+autodoc_mock_imports = ['mmcv._ext']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

requirements/readthedocs.txt

@@ -4,6 +4,7 @@ lanms-proper
 lmdb
 matplotlib
 mmcv
+mmdet
 Polygon3
 pyclipper
 rapidfuzz