Show more docs content

Author: adamtheturtle

docs/source/conf.py

@@ -76,6 +76,7 @@
 html_show_copyright = False
 html_show_sphinx = False
 html_show_sourcelink = False
+autoclass_content = 'both'
 
 html_theme_options = {
     'show_powered_by': 'false',

docs/source/index.rst

@@ -15,6 +15,11 @@ Reference
 ---------
 
 .. automodule:: vws
+   :undoc-members:
+   :members:
+
+.. automodule:: vws.include_target_data
+   :undoc-members:
    :members:
 
 .. toctree::

spelling_private_dict.txt

@@ -1,6 +1,7 @@
 AuthenticationFailure
 BadImage
 ImageTooLarge
+MaxNumResultsOutOfRange
 MetadataTooLarge
 ProjectInactive
 TargetNameExist

src/vws/__init__.py

@@ -3,12 +3,11 @@
 """
 
 from ._version import get_versions
-from .query import CloudRecoIncludeTargetData, CloudRecoService
+from .query import CloudRecoService
 from .vws import VWS
 
 __all__ = [
     'CloudRecoService',
-    'CloudRecoIncludeTargetData',
     'VWS',
 ]
 

src/vws/include_target_data.py

@@ -0,0 +1,15 @@
+"""
+Tools for managing ``CloudRecoService.query``'s ``include_target_data``.
+"""
+
+from enum import Enum
+
+
+class CloudRecoIncludeTargetData(Enum):
+    """
+    Options for the ``include_target_data`` parameter of foo.
+    """
+
+    TOP = 'top'
+    NONE = 'none'
+    ALL = 'all'

src/vws/query.py

@@ -3,29 +3,18 @@
 """
 
 import io
-from enum import Enum
 from typing import Any, Dict, List
 from urllib.parse import urljoin
 
 import requests
 from urllib3.filepost import encode_multipart_formdata
 
 from ._authorization import authorization_header, rfc_1123_date
+from .include_target_data import CloudRecoIncludeTargetData
 from ._result_codes import raise_for_result_code
 from .exceptions import MaxNumResultsOutOfRange
 
 
-class CloudRecoIncludeTargetData(Enum):
-    """
-    Options for the ``include_target_data`` parameter of
-    ``CloudRecoService.query``.
-    """
-
-    TOP = 'top'
-    NONE = 'none'
-    ALL = 'all'
-
-
 class CloudRecoService:
     """
     An interface to the Vuforia Cloud Recognition Web APIs.
@@ -52,7 +41,7 @@ def query(
         image: io.BytesIO,
         max_num_results: int = 1,
         include_target_data:
-        CloudRecoIncludeTargetData = CloudRecoIncludeTargetData.TOP,
+        'CloudRecoIncludeTargetData' = CloudRecoIncludeTargetData.TOP,
     ) -> List[Dict[str, Any]]:
         """
         Use the Vuforia Web Query API to make an Image Recognition Query.
@@ -71,8 +60,8 @@ def query(
                 none (return no target_data), all (for all matched targets)".
 
         Raises:
-            MaxNumResultsOutOfRange: ``max_num_results`` is not within the
-            range (1, 50).
+            ~vws.exceptions.MaxNumResultsOutOfRange: `max_num_results`` is not
+                within the range (1, 50).
 
         Returns:
             An ordered list of target details of matching targets.