Move headings to Sphinx template

This improves the layout of the docs and makes the class documentation
more usable in Python. Also includes some minor wording changes.

Author: oschwald

docs/index.rst

@@ -8,35 +8,51 @@
 
 .. include:: ../README.rst
 
-=======
-Modules
-=======
-
 .. automodule:: geoip2
     :members:
     :inherited-members:
     :show-inheritance:
 
+===============
+Database Reader
+===============
+
 .. automodule:: geoip2.database
     :members:
     :inherited-members:
     :show-inheritance:
 
+==================
+WebServices Client
+==================
+
 .. automodule:: geoip2.webservice
     :members:
     :inherited-members:
     :show-inheritance:
 
+======
+Models
+======
+
 .. automodule:: geoip2.models
     :members:
     :inherited-members:
     :show-inheritance:
 
+=======
+Records
+=======
+
 .. automodule:: geoip2.records
     :members:
     :inherited-members:
     :show-inheritance:
 
+======
+Errors
+======
+
 .. automodule:: geoip2.errors
     :members:
     :inherited-members:

geoip2/_internal.py

@@ -1,4 +1,4 @@
-"""This package contains internal utilities."""
+"""Internal utilities."""
 
 # pylint: disable=too-few-public-methods
 from abc import ABCMeta
@@ -15,7 +15,7 @@ def __ne__(self, other) -> bool:
 
     # pylint: disable=too-many-branches
     def to_dict(self) -> dict:
-        """Returns a dict of the object suitable for serialization."""
+        """Return a dict of the object suitable for serialization."""
         result = {}
         for key, value in self.__dict__.items():
             if key.startswith("_"):

geoip2/database.py

@@ -1,9 +1,4 @@
-"""
-======================
-GeoIP2 Database Reader
-======================
-
-"""
+"""The database reader for MaxMind MMDB files."""
 
 import inspect
 import os

geoip2/errors.py

@@ -1,11 +1,6 @@
-"""
-Errors
-======
-
-"""
+"""Typed errors thrown by this library."""
 
 import ipaddress
-
 from typing import Optional, Union
 
 

geoip2/models.py

@@ -1,14 +1,8 @@
-"""
-Models
-======
-
-These classes provide models for the data returned by the GeoIP2
-web service and databases.
+"""The models for response from th GeoIP2 web service and databases.
 
 The only difference between the City and Insights model classes is which
 fields in each record may be populated. See
 https://dev.maxmind.com/geoip/docs/web-services?lang=en for more details.
-
 """
 
 # pylint: disable=too-many-instance-attributes,too-few-public-methods,too-many-arguments

geoip2/records.py

@@ -1,9 +1,4 @@
-"""
-
-Records
-=======
-
-"""
+"""Record classes used within the response models."""
 
 # pylint:disable=too-many-arguments,too-many-positional-arguments,too-many-instance-attributes,too-many-locals
 

geoip2/webservice.py

@@ -1,10 +1,6 @@
-"""
-============================
-WebServices Client API
-============================
+"""Client for GeoIP2 and GeoLite2 web services.
 
-This class provides a client API for all the GeoIP2 web services. The web
-services are Country, City Plus, and Insights. Each service returns a
+The web services are Country, City Plus, and Insights. Each service returns a
 different set of data about an IP address, with Country returning the least
 data and Insights the most.