deploy: b289f69

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: 93cbce30c98ccf15c384eb80631abd7e
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 934cbeb1338df4cbf71c23d0a32332f4
 tags: 645f666f9bcd5a90fca523b33c5a78b7

.rsync-exclude

@@ -0,0 +1,31 @@
+.. _example_package documentation:
+
+|title|
+=======
+
+.. |title| replace:: diffpy.srreal.example_package package
+
+.. automodule:: diffpy.srreal.example_package
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+|foo|
+-----
+
+.. |foo| replace:: diffpy.srreal.example_package.foo module
+
+.. automodule::  diffpy.srreal.example_package.foo
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+|bar|
+-----
+
+.. |bar| replace:: diffpy.srreal.example_package.bar module
+
+.. automodule:: diffpy.srreal.example_package.foo
+    :members:
+    :undoc-members:
+    :show-inheritance:

_sources/api/diffpy.srreal.example_package.rst.txt

@@ -1,163 +1,30 @@
-:tocdepth: 2
+:tocdepth: -1
 
-.. default-role:: py:obj
+|title|
+=======
 
-diffpy.srreal package
-=====================
+.. |title| replace:: diffpy.srreal package
 
 .. automodule:: diffpy.srreal
     :members:
     :undoc-members:
     :show-inheritance:
 
-Submodules
-----------
-
-diffpy.srreal.atomradiitable module
------------------------------------
-
-.. automodule:: diffpy.srreal.atomradiitable
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.attributes module
--------------------------------
-
-.. automodule:: diffpy.srreal.attributes
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.bondcalculator module
------------------------------------
-
-.. automodule:: diffpy.srreal.bondcalculator
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.bvparameterstable module
---------------------------------------
-
-.. automodule:: diffpy.srreal.bvparameterstable
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.bvscalculator module
-----------------------------------
-
-.. automodule:: diffpy.srreal.bvscalculator
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.eventticker module
---------------------------------
-
-.. automodule:: diffpy.srreal.eventticker
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.overlapcalculator module
---------------------------------------
-
-.. automodule:: diffpy.srreal.overlapcalculator
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.pairquantity module
----------------------------------
-
-.. automodule:: diffpy.srreal.pairquantity
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.parallel module
------------------------------
+Subpackages
+-----------
 
-.. automodule:: diffpy.srreal.parallel
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.pdfbaseline module
---------------------------------
-
-.. automodule:: diffpy.srreal.pdfbaseline
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.pdfcalculator module
-----------------------------------
-
-.. automodule:: diffpy.srreal.pdfcalculator
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.pdfenvelope module
---------------------------------
+.. toctree::
+   diffpy.srreal.example_package
 
-.. automodule:: diffpy.srreal.pdfenvelope
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.peakprofile module
---------------------------------
-
-.. automodule:: diffpy.srreal.peakprofile
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.peakwidthmodel module
------------------------------------
-
-.. automodule:: diffpy.srreal.peakwidthmodel
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.scatteringfactortable module
-------------------------------------------
-
-.. automodule:: diffpy.srreal.scatteringfactortable
-    :members: ScatteringFactorTable, SFTXray,
-      SFTElectron, SFTNeutron, SFTElectronNumber
-    :undoc-members:
-    :show-inheritance:
-
-diffpy.srreal.sfaverage module
-------------------------------
-
-.. automodule:: diffpy.srreal.sfaverage
-    :members:
-    :undoc-members:
-    :no-show-inheritance:
-
-diffpy.srreal.structureadapter module
--------------------------------------
-
-.. automodule:: diffpy.srreal.structureadapter
-    :members:
-    :undoc-members:
-    :show-inheritance:
+Submodules
+----------
 
-.. skip internal module diffpy.srreal.structureconverters
+|module|
+--------
 
-diffpy.srreal.version module
-----------------------------
+.. |module| replace:: diffpy.srreal.example_submodule module
 
-.. automodule:: diffpy.srreal.version
+.. automodule:: diffpy.srreal.example_submodule
     :members:
     :undoc-members:
     :show-inheritance:
-
-.. skip internal module diffpy.srreal.wraputils

_sources/api/diffpy.srreal.rst.txt

@@ -0,0 +1,4 @@
+.. _examples:
+
+Examples
+########

_sources/examples.rst.txt

@@ -1,10 +1,12 @@
-####################################################
-diffpy.srreal documentation
-####################################################
+#######
+|title|
+#######
 
-diffpy.srreal - calculators for PDF, bond valence sum and other pair quantities.
+.. |title| replace:: diffpy.srreal documentation
 
-| Software version |release|.
+``diffpy.srreal`` - Calculators for PDF, bond valence sum, and other quantities based on atom pair interaction.
+
+| Software version |release|
 | Last updated |today|.
 
 The diffpy.srreal package provides calculators for atomic pair distribution
@@ -37,9 +39,9 @@ calculate PDF with a user-defined profile function.  A new calculator class
 can be also defined for any quantity that is obtained by iteration over atom
 pairs, by defining only the function that processes atom-pair contributions.
 
-========================================
+=======
 Authors
-========================================
+=======
 
 diffpy.srreal is developed by members of the Billinge Group at
 Columbia University and at Brookhaven National Laboratory including
@@ -48,28 +50,42 @@ Pavol Juhás, Christopher L. Farrow, Simon J.L. Billinge.
 For a detailed list of contributors see
 https://github.com/diffpy/diffpy.srreal/graphs/contributors.
 
-======================================
+Reference
+=========
+
+If you use this program for a scientific research that leads
+to publication, we ask that you acknowledge use of the program
+by citing the following paper in your publication:
+
+   diffpy.srreal Package, https://github.com/diffpy/diffpy.srreal
+
+============
 Installation
-======================================
+============
 
-See the `README <https://github.com/diffpy/diffpy.srreal#requirements>`_
+See the `README <https://github.com/diffpy/diffpy.srreal#installation>`_
 file included with the distribution.
 
-======================================
-Table of contents
-======================================
+================
+Acknowledgements
+================
+
+``diffpy.srreal`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.
 
+=================
+Table of contents
+=================
 .. toctree::
    :titlesonly:
 
    license
    release
+   examples
    Package API <api/diffpy.srreal>
 
-======================================
+=======
 Indices
-======================================
+=======
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`