From 2428702fb653617658b99319a232f9b76454ee91 Mon Sep 17 00:00:00 2001
From: Andrew Johnson <drewej@protonmail.com>
Date: Tue, 17 Sep 2019 11:11:39 -0500
Subject: [PATCH] Improved documentation for depletion module

* __call__ methods for Operator documented
* CRAM16 and CRAM48 are closer to the top of the page
* Document deplete and timed_deplete functions
* Abstract integrators documented as part of abc submodule
* Abstract operator helpers documented as part of abc submodule
---
 docs/source/_templates/mycallable.rst |  9 ++++++++
 docs/source/pythonapi/deplete.rst     | 30 ++++++++++++++-------------
 2 files changed, 25 insertions(+), 14 deletions(-)
 create mode 100644 docs/source/_templates/mycallable.rst

diff --git a/docs/source/_templates/mycallable.rst b/docs/source/_templates/mycallable.rst
new file mode 100644
index 000000000..85fdd34c3
--- /dev/null
+++ b/docs/source/_templates/mycallable.rst
@@ -0,0 +1,9 @@
+{{ fullname }}
+{{ underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+    :members:
+    :special-members: __call__
+    
diff --git a/docs/source/pythonapi/deplete.rst b/docs/source/pythonapi/deplete.rst
index 5b26eb38a..531723b72 100644
--- a/docs/source/pythonapi/deplete.rst
+++ b/docs/source/pythonapi/deplete.rst
@@ -31,7 +31,7 @@ specific to OpenMC is available using the following class:
 .. autosummary::
    :toctree: generated
    :nosignatures:
-   :template: myclass.rst
+   :template: mycallable.rst
 
    Operator
 
@@ -82,6 +82,19 @@ data, such as number densities and reaction rates for each material.
    Results
    ResultsList
 
+The following functions are used to solve the depletion equations, with
+:func:`cram.CRAM48` being the default.
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myfunction.rst
+
+   cram.CRAM16
+   cram.CRAM48
+   cram.deplete
+   cram.timed_deplete
+
 The following classes are used to help the :class:`openmc.deplete.Operator`
 compute quantities like effective fission yields, reaction rates, and
 total system energy.
@@ -119,16 +132,5 @@ base classes:
    :nosignatures:
    :template: myintegrator.rst
 
-   Integrator
-   SIIntegrator
-
-Each of the integrator classes also relies on a number of "helper" functions
-as follows:
-
-.. autosummary::
-   :toctree: generated
-   :nosignatures:
-   :template: myfunction.rst
-
-   cram.CRAM16
-   cram.CRAM48
+   abc.Integrator
+   abc.SIIntegrator