Add module level docstrings to api docs.

Author: michelp

suitesparse_graphblas/__init__.py

@@ -1,3 +1,5 @@
+"""Low-level Python CFFI binding for SuiteSparse:GraphBLAS."""
+
 import importlib.metadata
 import platform
 import struct as _struct

suitesparse_graphblas/api/__init__.py

@@ -1,3 +1,19 @@
+"""SuiteSparse:GraphBLAS is a full implementation of the GraphBLAS
+standard, which defines a set of sparse matrix operations on an
+extended algebra of semirings using an almost unlimited variety of
+operators and types. When applied to sparse adjacency matrices, these
+algebraic operations are equivalent to computations on graphs.
+GraphBLAS provides a powerful and expressive framework for creating
+high-performance graph algorithms based on the elegant mathematics of
+sparse matrix operations on a semiring.
+
+This module contains the "functional API" for
+python-suitesparse-graphblas.  This is a higher level API than the
+"raw" CFFI binding, but a lower level API than the algebraic
+functionality provided by the
+[python-graphblas](https://python-graphblas.readthedocs.io/en/stable/api_reference/index.html)
+library.
+"""
 from suitesparse_graphblas.api import (
     binaryop,
     container,

suitesparse_graphblas/api/matrix.py

@@ -1,3 +1,5 @@
+"""Create, manipulate, and query GrB_Matrix objects."""
+
 import numpy as np
 
 from suitesparse_graphblas import check_status, ffi, lib, supports_complex

suitesparse_graphblas/api/scalar.py

@@ -1,3 +1,5 @@
+"""Create, manipulate, and query GxB_Scalar objects."""
+
 from suitesparse_graphblas import check_status, exceptions, ffi, lib, supports_complex
 
 from .utils import _capture_c_output  # noqa: F401

suitesparse_graphblas/api/vector.py

@@ -1,3 +1,5 @@
+"""Create, manipulate, and query GrB_Vector objects."""
+
 import numpy as np
 
 from suitesparse_graphblas import check_status, ffi, lib, supports_complex