DOC: start API documents with package summary

pavoljuhas · pavoljuhas · commit 0d672e4a54e8 · 2019-03-13T16:14:18.000-04:00
diff --git a/doc/manual/source/api/diffpy.srreal.rst b/doc/manual/source/api/diffpy.srreal.rst
@@ -1,6 +1,13 @@
+:tocdepth: 2
+
 diffpy.srreal package
 =====================
 
+.. automodule:: diffpy.srreal
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 Submodules
 ----------
 
@@ -164,12 +171,3 @@ diffpy.srreal.wraputils module
     :members:
     :undoc-members:
     :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: diffpy.srreal
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/doc/manual/source/index.rst b/doc/manual/source/index.rst
@@ -64,7 +64,11 @@ Table of contents
 
    license
    release
-   api/diffpy.srreal.rst
+   Package API <api/diffpy.srreal>
+
+======================================
+Indices
+======================================
 
 * :ref:`genindex`
 * :ref:`modindex`
