Add doc page

.gitlab-ci.yml

@@ -4,6 +4,7 @@ variables:
 stages:
   - linting
   - test
+  - deploy
 
 before_script:
   - echo $PATH
@@ -13,7 +14,8 @@ before_script:
   - pip --version
   - python -c "import torch; print(torch.__version__)"
 
-.linting_template: &linting_template_def
+linting:
+  image: $PYTORCH_IMAGE
   stage: linting
   script:
     - pip install flake8==3.7.9 yapf isort
@@ -35,10 +37,24 @@ before_script:
     - coverage run --branch --source mmdet3d -m pytest tests/
     - coverage report -m
 
-linting:pytorch1.3-cuda10:
-  image: $PYTORCH_IMAGE
-  <<: *linting_template_def
-
 test:pytorch1.3-cuda10:
   image: $PYTORCH_IMAGE
   <<: *test_template_def
+
+pages:
+  image: $PYTORCH_IMAGE
+  stage: deploy
+  script:
+    - pip install numba==0.48.0
+    - pip install sphinx sphinx_rtd_theme recommonmark sphinx_markdown_tables
+    - cd docs
+    - make html
+    - cd ..
+    - mkdir -p ./public
+    - cp -r docs/_build/html/* ./public
+    - ls ./public
+  artifacts:
+    paths:
+      - public
+  only:
+    - master

docs/api.rst

@@ -40,7 +40,7 @@ utils
     :members:
 
 mmdet3d.datasets
---------------
+----------------
 
 datasets
 ^^^^^^^^^^

docs/conf.py

@@ -39,7 +39,12 @@ extensions = [
 ]
 
 autodoc_mock_imports = [
-    'matplotlib', 'pycocotools', 'terminaltables', 'mmdet3d.version',
+    'cv2', 'matplotlib', 'nuscenes', 'PIL', 'pycocotools', 'pyquaternion',
+    'terminaltables', 'mmcv', 'mmdet', 'mmdet3d.version',
+    'mmdet3d.ops.ball_query', 'mmdet3d.ops.furthest_point_sample',
+    'mmdet3d.ops.gather_points', 'mmdet3d.ops.group_points',
+    'mmdet3d.ops.interpolate', 'mmdet3d.ops.roiaware_pool3d',
+    'mmdet3d.ops.spconv', 'mmdet3d.ops.voxel.voxel_layer', 'mmdet3d.ops.iou3d'
 ]
 
 # Add any paths that contain templates here, relative to this directory.