Enable doctests in CI with xdoctest (open-mmlab#1479)

* Enable doctests in CI with xdoctest

* use xdoctest in travis file

* Fix doctest warnings

* dont test eggs directory

* Ensure xdoctest is installed before running CI

.travis.yml

@@ -33,7 +33,7 @@ script:
   - yapf -r -d --style .style.yapf mmdet/ tools/ tests/
   - python setup.py check -m -s
   - python setup.py build_ext --inplace
-  - coverage run --source mmdet -m py.test tests -v --doctest-modules
+  - coverage run --source mmdet -m py.test -v --xdoctest-modules tests mmdet
 
 after_success:
-  - coverage report
+  - coverage report

mmdet/models/bbox_heads/convfc_bbox_head.py

@@ -7,7 +7,7 @@
 
 @HEADS.register_module
 class ConvFCBBoxHead(BBoxHead):
-    """More general bbox head, with shared conv and fc layers and two optional
+    r"""More general bbox head, with shared conv and fc layers and two optional
     separated branches.
 
                                 /-> cls convs -> cls fcs -> cls

mmdet/models/bbox_heads/double_bbox_head.py

@@ -71,7 +71,7 @@ def forward(self, x):
 
 @HEADS.register_module
 class DoubleConvFCBBoxHead(BBoxHead):
-    """Bbox head used in Double-Head R-CNN
+    r"""Bbox head used in Double-Head R-CNN
 
                                       /-> cls
                   /-> shared convs ->

mmdet/models/losses/utils.py

@@ -64,6 +64,7 @@ def weighted_loss(loss_func):
 
     :Example:
 
+    >>> import torch
     >>> @weighted_loss
     >>> def l1_loss(pred, target):
     >>>     return (pred - target).abs()

mmdet/models/mask_heads/fused_semantic_head.py

@@ -9,7 +9,7 @@
 
 @HEADS.register_module
 class FusedSemanticHead(nn.Module):
-    """Multi-level fused semantic segmentation head.
+    r"""Multi-level fused semantic segmentation head.
 
     in_1 -> 1x1 conv ---
                         |

pytest.ini

@@ -0,0 +1,7 @@
+[pytest]
+addopts = --xdoctest --xdoctest-style=auto
+norecursedirs = .git ignore build __pycache__ data docker docs .eggs
+
+filterwarnings= default
+                ignore:.*No cfgstr given in Cacher constructor or call.*:Warning
+                ignore:.*Define the __nice__ method for.*:Warning

setup.py

@@ -152,7 +152,7 @@ def get_requirements(filename='requirements.txt'):
         ],
         license='Apache License 2.0',
         setup_requires=['pytest-runner', 'cython', 'numpy'],
-        tests_require=['pytest'],
+        tests_require=['pytest', 'xdoctest'],
         install_requires=get_requirements(),
         ext_modules=[
             make_cython_ext(

tests/requirements.txt

@@ -2,4 +2,5 @@ isort
 flake8
 yapf
 pytest-cov
-codecov
+codecov
+xdoctest >= 0.10.0