Embed API documentation in index

rhpvorderman · rhpvorderman · commit 1b54dcebb3c8 · 2020-09-28T16:05:04.000+02:00
diff --git a/docs/igzip.rst b/docs/igzip.rst
@@ -1,5 +1,9 @@
-igzip
-=========
+API-documentation: igzip
+========================
 
 .. automodule:: isal.igzip
-   :members:
+   :members: compress, decompress, open
+
+   .. autoclass:: IGzipFile
+      :members:
+      :special-members: __init__
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,6 +10,9 @@ Welcome to python-isal's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   isal_zlib
+   igzip
+
 
 
 Indices and tables
diff --git a/docs/isal_zlib.rst b/docs/isal_zlib.rst
@@ -1,5 +1,5 @@
-isal_zlib
-=========
+API Documentation: isal_zlib
+============================
 
 .. automodule:: isal.isal_zlib
    :members:
