deploy: fbf89f1

Author: sbillinge

.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: cf8de2f77ab2104bc5bb23b3562ea33e
-tags: fbb0d17656682115ca4d033fb2f83ba1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 230e8ba9d9bc04231b60a4f73b6cb720
+tags: 645f666f9bcd5a90fca523b33c5a78b7

.rsync-exclude

@@ -3,6 +3,4 @@ diffpy Package
 
 .. toctree::
 
-    diffpy.confutils
     diffpy.srxplanar
-

_sources/api/diffpy.confutils.txt

@@ -1,67 +1,84 @@
-srxplanar Package
-=================
+:tocdepth: -1
 
-:mod:`srxplanar` Package
-------------------------
+|title|
+=======
+
+.. |title| replace:: diffpy.srxplanar package
 
 .. automodule:: diffpy.srxplanar
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`calculate` Module
------------------------
+Submodules
+---------------------
+
+|module_1|
+----------
+
+.. |module_1| replace:: diffpy.srxplanar.calculate module
 
 .. automodule:: diffpy.srxplanar.calculate
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`loadimage` Module
------------------------
+|module_2|
+----------
+
+.. |module_2| replace:: diffpy.srxplanar.loadimage module
 
 .. automodule:: diffpy.srxplanar.loadimage
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`mask` Module
-------------------
+|module_3|
+----------
+
+.. |module_3| replace:: diffpy.srxplanar.mask module
 
 .. automodule:: diffpy.srxplanar.mask
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`saveresults` Module
--------------------------
+|module_4|
+----------
+
+.. |module_4| replace:: diffpy.srxplanar.saveresults module
 
 .. automodule:: diffpy.srxplanar.saveresults
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`srxplanar` Module
------------------------
+|module_5|
+----------
+
+.. |module_5| replace:: diffpy.srxplanar.srxplanar module
 
 .. automodule:: diffpy.srxplanar.srxplanar
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`srxplanarconfig` Module
------------------------------
+|module_6|
+----------
+
+.. |module_6| replace:: diffpy.srxplanar.srxplanarconfig module
 
 .. automodule:: diffpy.srxplanar.srxplanarconfig
     :members:
     :undoc-members:
     :show-inheritance:
 
-:mod:`version` Module
----------------------
+|module_7|
+----------
+
+.. |module_7| replace:: diffpy.srxplanar.version module
 
 .. automodule:: diffpy.srxplanar.version
     :members:
     :undoc-members:
     :show-inheritance:
-

_sources/api/diffpy.txt _sources/api/diffpy.rst.txt_sources/api/diffpy.txt renamed to _sources/api/diffpy.rst.txt

@@ -0,0 +1,57 @@
+#######
+|title|
+#######
+
+.. |title| replace:: diffpy.srxplanar documentation
+
+| Software version |release|
+| Last updated |today|.
+
+diffpy.srxplanar package provides 2D diffraction image integration using
+non splitting pixel algorithm. And it can estimate and propagate statistic
+uncertainty of raw counts and integrated intensity. If you are using this
+software. If you use this program to do productive scientific research that
+leads to publication, we kindly ask that you acknowledge use of the program
+by citing the following paper in your publication:
+
+    Xiaohao Yang, Pavol Juhas, Simon J. L. Billinge, On the estimation of
+    statistical uncertainties on powder diffraction and small angle
+    scattering data from 2-D x-ray detectors, arXiv:1309.3614
+
+=======
+Authors
+=======
+
+``diffpy.srxplanar`` is developed by Xiaohao Yang and Billinge Group members. The maintainer for this project is Simon Billinge. For a detailed list of contributors see
+https://github.com/diffpy/diffpy.srxplanar/graphs/contributors.
+
+============
+Installation
+============
+
+See the `README <https://github.com/diffpy/diffpy.srxplanar#installation>`_
+file included with the distribution.
+
+================
+Acknowledgements
+================
+
+``diffpy.srxplanar`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.
+
+=================
+Table of contents
+=================
+.. toctree::
+   :maxdepth: 2
+
+   Package API <api/diffpy.srxplanar>
+   Modules <api/modules>
+   Release notes <release>
+   license
+
+=======
+Indices
+=======
+
+* :ref:`genindex`
+* :ref:`search`