Merge pull request #173 from maxmind/greg/eng-1824

Improve docs and dev dep management

Author: marselester

docs/index.rst

@@ -3,24 +3,40 @@
 
 .. include:: ../README.rst
 
-=======
-Modules
-=======
+==================
+Web Service Client
+==================
 
 .. automodule:: minfraud
     :members:
+    :inherited-members:
+    :show-inheritance:
     :no-undoc-members:
 
 .. automodule:: minfraud.webservice
     :members:
+    :inherited-members:
+    :show-inheritance:
     :no-undoc-members:
 
+===============
+Response Models
+===============
+
 .. automodule:: minfraud.models
     :members:
+    :inherited-members:
+    :show-inheritance:
     :no-undoc-members:
 
+======
+Errors
+======
+
 .. automodule:: minfraud.errors
     :members:
+    :inherited-members:
+    :show-inheritance:
     :no-undoc-members:
 
 ==================

minfraud/__init__.py

@@ -1,9 +1,4 @@
-"""
-minfraud
-~~~~~~~~
-
-A client API to MaxMind's minFraud Score and Insights web services.
-"""
+"""minFraud client module."""
 
 # flake8: noqa: F401
 from .errors import (

minfraud/errors.py

@@ -1,10 +1,4 @@
-"""
-minfraud.errors
-~~~~~~~~~~~~~~~
-
-This module contains errors that are raised by this package.
-
-"""
+"""Typed errors thrown by this library."""
 
 from typing import Optional
 
@@ -26,30 +20,16 @@ class HTTPError(MinFraudError):
 
     This class represents an HTTP transport error. It extends
     :py:exc:`MinFraudError` and adds attributes of its own.
-
-    .. attribute:: http_status:
-
-      The HTTP status code returned
-
-      :type: int
-
-    .. attribute:: uri:
-
-      The URI queried
-
-      :type: str
-
-    .. attribute:: decoded_content:
-
-      The decoded response content
-
-      :type: str
-
     """
 
     http_status: Optional[int]
+    """The HTTP status code returned"""
+
     uri: Optional[str]
+    """The URI queried"""
+
     decoded_content: Optional[str]
+    """The decoded response content"""
 
     def __init__(
         self,
@@ -58,6 +38,7 @@ def __init__(
         uri: Optional[str] = None,
         decoded_content: Optional[str] = None,
     ) -> None:
+        """Initialize an HTTPError instance."""
         super().__init__(message)
         self.http_status = http_status
         self.uri = uri