Merge pull request #103 from bobleesj/doc

Include api doc

Author: sbillinge

doc/source/api/diffpy.utils.parsers.rst

@@ -1,4 +1,4 @@
-.. _Parsers Documentation:
+:tocdepth: -1
 
 diffpy.utils.parsers package
 ============================
@@ -8,28 +8,37 @@ diffpy.utils.parsers package
     :undoc-members:
     :show-inheritance:
 
-For a sample data extraction workflow, see :ref:`parsers example<Parsers Example>`.
+Submodules
+----------
+
+diffpy.utils.parsers.resample module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: diffpy.utils.parsers.resample
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
 diffpy.utils.parsers.loaddata module
-------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. automodule:: diffpy.utils.parsers.loaddata
     :members:
     :undoc-members:
     :show-inheritance:
 
-diffpy.utils.parsers.serialization module
------------------------------------------
+diffpy.utils.parsers.custom_exceptions module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. automodule:: diffpy.utils.parsers.serialization
+.. automodule:: diffpy.utils.parsers.custom_exceptions
     :members:
     :undoc-members:
     :show-inheritance:
 
-diffpy.utils.parsers.resample module
-------------------------------------
+diffpy.utils.parsers.serialization module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. automodule:: diffpy.utils.parsers.resample
+.. automodule:: diffpy.utils.parsers.serialization
     :members:
     :undoc-members:
     :show-inheritance:

doc/source/api/diffpy.utils.rst

@@ -12,15 +12,17 @@ Subpackages
 -----------
 
 .. toctree::
+    :titlesonly:
 
     diffpy.utils.parsers
     diffpy.utils.wx
+    diffpy.utils.scattering_objects
 
 Submodules
 ----------
 
 diffpy.utils.tools module
--------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. automodule:: diffpy.utils.tools
     :members:

doc/source/api/diffpy.utils.scattering_objects.rst

@@ -0,0 +1,28 @@
+:tocdepth: -1
+
+diffpy.utils.scattering_objects package
+=======================================
+
+.. automodule:: diffpy.utils.scattering_objects
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+diffpy.utils.scattering_objects.user_config module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: diffpy.utils.scattering_objects.user_config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+diffpy.utils.scattering_objects.diffraction_objects module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: diffpy.utils.scattering_objects.diffraction_objects
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/api/diffpy.utils.wx.rst

@@ -1,4 +1,4 @@
-.. _wx Python Utilities Documentation
+:tocdepth: -1
 
 diffpy.utils.wx package
 =======================
@@ -8,8 +8,11 @@ diffpy.utils.wx package
     :undoc-members:
     :show-inheritance:
 
+Submodules
+----------
+
 diffpy.utils.wx.gridutils module
---------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. automodule:: diffpy.utils.wx.gridutils
     :members: