diff --git a/docs/conf.py b/docs/conf.py index b286571..b9f5f28 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -162,6 +162,18 @@ autodoc_mock_imports = [] nitpick_ignore = [ ('py:class', 'object'), + ('py:class', 'bool'), + ('py:class', 'dict'), + ('py:class', 'list'), + ('py:class', 'str'), + ('py:class', 'int'), + ('py:class', 'bytes'), + ('py:class', 'tuple'), + ('py:class', 'callable'), + ('py:class', 'type'), + ('py:class', 'OrderedDict'), + ('py:class', 'None'), + ('py:class', 'Exception'), ('py:class', 'collections.OrderedDict'), @@ -174,29 +186,17 @@ nitpick_ignore = [ ('py:class', 'OpenAPICodecJson'), ('py:class', 'OpenAPISchemaGenerator'), - ('py:obj', 'bool'), - ('py:obj', 'dict'), - ('py:obj', 'list'), - ('py:obj', 'str'), - ('py:obj', 'int'), - ('py:obj', 'bytes'), - ('py:obj', 'tuple'), - ('py:obj', 'callable'), - ('py:obj', 'type'), - ('py:obj', 'OrderedDict'), - ('py:obj', 'None'), - - ('py:obj', 'coreapi.Field'), - ('py:obj', 'BaseFilterBackend'), - ('py:obj', 'BasePagination'), - ('py:obj', 'Request'), - ('py:obj', 'rest_framework.request.Request'), - ('py:obj', 'rest_framework.serializers.Field'), - ('py:obj', 'serializers.Field'), - ('py:obj', 'serializers.BaseSerializer'), - ('py:obj', 'Serializer'), - ('py:obj', 'BaseSerializer'), - ('py:obj', 'APIView'), + ('py:class', 'coreapi.Field'), + ('py:class', 'BaseFilterBackend'), + ('py:class', 'BasePagination'), + ('py:class', 'Request'), + ('py:class', 'rest_framework.request.Request'), + ('py:class', 'rest_framework.serializers.Field'), + ('py:class', 'serializers.Field'), + ('py:class', 'serializers.BaseSerializer'), + ('py:class', 'Serializer'), + ('py:class', 'BaseSerializer'), + ('py:class', 'APIView'), ] # even though the package should be already installed, the sphinx build on RTD diff --git a/requirements/docs.txt b/requirements/docs.txt index 769f0a4..58790aa 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -1,5 +1,5 @@ # used by the 'docs' tox env for building the documentation -Sphinx>=1.6.5 +Sphinx>=1.7.0 sphinx_rtd_theme>=0.2.4 Pillow>=4.3.0 readme_renderer>=17.2