Minor doc rendering improvements

Author: oschwald

docs/index.rst

@@ -8,20 +8,28 @@
 
 .. include:: ../README.rst
 
-=======
-Modules
-=======
+======
+Module
+======
 
 .. automodule:: maxminddb
     :members:
     :undoc-members:
     :show-inheritance:
 
+======
+Errors
+======
+
 .. automodule:: maxminddb.errors
     :members:
     :undoc-members:
     :show-inheritance:
 
+===============
+Database Reader
+===============
+
 .. automodule:: maxminddb.reader
     :members:
     :undoc-members:

maxminddb/__init__.py

@@ -1,3 +1,4 @@
+"""Module for reading MaxMind DB files."""
 # pylint:disable=C0111
 import os
 from typing import IO, AnyStr, Union, cast

maxminddb/decoder.py

@@ -1,10 +1,4 @@
-"""
-maxminddb.decoder
-~~~~~~~~~~~~~~~~~
-
-This package contains code for decoding the MaxMind DB data section.
-
-"""
+"""Decoder for the MaxMind DB data section."""
 
 import struct
 from typing import Dict, List, Tuple, Union, cast

maxminddb/errors.py

@@ -1,10 +1,5 @@
-"""
-maxminddb.errors
-~~~~~~~~~~~~~~~~
-
-This module contains custom errors for the MaxMind DB reader
-"""
+"""Typed errors thrown by this library."""
 
 
 class InvalidDatabaseError(RuntimeError):
-    """This error is thrown when unexpected data is found in the database."""
+    """An error thrown when unexpected data is found in the database."""

maxminddb/extension.pyi

@@ -1,10 +1,4 @@
-"""
-maxminddb.extension
-~~~~~~~~~~~~~~~~
-
-This module contains the C extension database reader and related classes.
-
-"""
+"""C extension database reader and related classes."""
 
 # pylint: disable=E0601,E0602
 from ipaddress import IPv4Address, IPv6Address

maxminddb/reader.py

@@ -1,10 +1,4 @@
-"""
-maxminddb.reader
-~~~~~~~~~~~~~~~~
-
-This module contains the pure Python database reader and related classes.
-
-"""
+"""Pure-Python reader for the MaxMind DB file format."""
 
 try:
     import mmap

maxminddb/types.py

@@ -1,9 +1,4 @@
-"""
-maxminddb.types
-~~~~~~~~~~~~~~~
-
-This module provides a Record type that represents a database record.
-"""
+"""Types representing database records."""
 
 from typing import AnyStr, Dict, List, Union