Start cleaning up documentation

docs/source/pythonapi/deplete.rst

@@ -0,0 +1,62 @@
+.. _pythonapi_deplete:
+
+----------------------------------
+:mod:`openmc.deplete` -- Depletion
+----------------------------------
+
+Integrators
+-----------
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myfunction.rst
+
+   openmc.deplete.integrator.predictor
+   openmc.deplete.integrator.cecm
+
+Integrator Helper Functions
+---------------------------
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myfunction.rst
+
+   openmc.deplete.integrator.CRAM16
+   openmc.deplete.integrator.CRAM48
+   openmc.deplete.integrator.save_results
+
+Metaclasses
+-----------
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.deplete.TransportOperator
+
+OpenMC Classes
+--------------
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.deplete.Operator
+   openmc.deplete.OperatorResult
+
+Data Classes
+------------
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.deplete.AtomNumber
+   openmc.deplete.Chain
+   openmc.deplete.Nuclide
+   openmc.deplete.ReactionRates
+   openmc.deplete.Results

docs/source/pythonapi/deplete/index.rst

@@ -1,54 +0,0 @@
-.. _api:
-
-=================
-API Documentation
-=================
-
-Integrators
------------
-
-.. toctree::
-    :maxdepth: 2
-
-    integrator.predictor
-    integrator.cecm
-
-Integrator Helper Functions
----------------------------
-.. toctree::
-    :maxdepth: 2
-
-    integrator.CRAM16
-    integrator.CRAM48
-    integrator.save_results
-
-Metaclasses
------------
-
-.. autosummary::
-   :toctree: generated
-   :nosignatures:
-
-   openmc.deplete.Operator
-
-OpenMC Classes
---------------
-
-.. autosummary::
-   :toctree: generated
-   :nosignatures:
-
-   openmc.deplete.Materials
-   openmc.deplete.OpenMCOperator
-
-Data Classes
-------------
-.. autosummary::
-   :toctree: generated
-   :nosignatures:
-
-   openmc.deplete.AtomNumber
-   openmc.deplete.Chain
-   openmc.deplete.Nuclide
-   openmc.deplete.ReactionRates
-   openmc.deplete.Results

docs/source/pythonapi/deplete/integrator.CRAM16.rst

@@ -1,6 +0,0 @@
-integrator\.CRAM16
-==================
-
-.. currentmodule:: openmc.deplete.integrator
-
-.. autofunction:: CRAM16

docs/source/pythonapi/deplete/integrator.CRAM48.rst

@@ -1,6 +0,0 @@
-integrator\.CRAM48
-==================
-
-.. currentmodule:: openmc.deplete.integrator
-
-.. autofunction:: CRAM48

docs/source/pythonapi/deplete/integrator.cecm.rst

@@ -1,6 +0,0 @@
-integrator\.cecm
-=================
-
-.. currentmodule:: openmc.deplete.integrator
-
-.. autofunction:: cecm

docs/source/pythonapi/deplete/integrator.predictor.rst

@@ -1,6 +0,0 @@
-integrator\.predictor
-=====================
-
-.. currentmodule:: openmc.deplete.integrator
-
-.. autofunction:: predictor

docs/source/pythonapi/deplete/integrator.save_results.rst

@@ -1,6 +0,0 @@
-integrator\.save_results
-========================
-
-.. currentmodule:: openmc.deplete.integrator
-
-.. autofunction:: save_results

docs/source/pythonapi/index.rst

@@ -15,14 +15,15 @@ there are many substantial benefits to using the Python API, including:
 - The ability to define dimensions using variables.
 - Availability of standard-library modules for working with files.
 - An entire ecosystem of third-party packages for scientific computing.
-- Ability to create materials based on natural elements or uranium enrichment
 - Automated multi-group cross section generation (:mod:`openmc.mgxs`)
+- A fully-featured nuclear data interface (:mod:`openmc.data`)
+- Depletion capability (:mod:`openmc.deplete`)
 - Convenience functions (e.g., a function returning a hexagonal region)
 - Ability to plot individual universes as geometry is being created
 - A :math:`k_\text{eff}` search function (:func:`openmc.search_for_keff`)
 - Random sphere packing for generating TRISO particle locations
   (:func:`openmc.model.pack_trisos`)
-- A fully-featured nuclear data interface (:mod:`openmc.data`)
+- Ability to create materials based on natural elements or uranium enrichment
 
 For those new to Python, there are many good tutorials available online. We
 recommend going through the modules from `Codecademy
@@ -45,6 +46,7 @@ Modules
    base
    model
    examples
+   deplete
    mgxs
    stats
    data