From 0cc1e6c09357321505052e3ea61456c9de9a4878 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Wed, 28 Oct 2015 09:09:28 -0500 Subject: [PATCH] Add summary of classes available in openmc.mgxs.mgxs module --- docs/source/conf.py | 1 + docs/source/pythonapi/mgxs.rst | 49 +++++++++++++++++++++++++--------- 2 files changed, 38 insertions(+), 12 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 4a18f14de5..05559aab08 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -27,6 +27,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.pngmath', + 'sphinx.ext.autosummary', 'sphinxcontrib.tikz', 'sphinx_numfig', 'notebook_sphinxext'] diff --git a/docs/source/pythonapi/mgxs.rst b/docs/source/pythonapi/mgxs.rst index 82bfdd2751..c7084e5653 100644 --- a/docs/source/pythonapi/mgxs.rst +++ b/docs/source/pythonapi/mgxs.rst @@ -4,38 +4,63 @@ Multi-Group Cross Sections ========================== -.. autoclass:: openmc.mgxs.mgxs.MGXS +.. currentmodule:: openmc.mgxs.mgxs + +---------------------------- +Summary of Available Classes +---------------------------- + +.. autosummary:: + + MGXS + AbsorptionXS + CaptureXS + Chi + FissionXS + NuFissionXS + NuScatterXS + NuScatterMatrixXS + ScatterXS + ScatterMatrixXS + TotalXS + TransportXS + +------------------- +Class Documentation +------------------- + +.. autoclass:: MGXS :members: -.. autoclass:: openmc.mgxs.mgxs.AbsorptionXS +.. autoclass:: AbsorptionXS :members: -.. autoclass:: openmc.mgxs.mgxs.CaptureXS +.. autoclass:: CaptureXS :members: -.. autoclass:: openmc.mgxs.mgxs.Chi +.. autoclass:: Chi :members: -.. autoclass:: openmc.mgxs.mgxs.FissionXS +.. autoclass:: FissionXS :members: -.. autoclass:: openmc.mgxs.mgxs.NuFissionXS +.. autoclass:: NuFissionXS :members: -.. autoclass:: openmc.mgxs.mgxs.NuScatterXS +.. autoclass:: NuScatterXS :members: -.. autoclass:: openmc.mgxs.mgxs.NuScatterMatrixXS +.. autoclass:: NuScatterMatrixXS :members: -.. autoclass:: openmc.mgxs.mgxs.ScatterXS +.. autoclass:: ScatterXS :members: -.. autoclass:: openmc.mgxs.mgxs.ScatterMatrixXS +.. autoclass:: ScatterMatrixXS :members: -.. autoclass:: openmc.mgxs.mgxs.TotalXS +.. autoclass:: TotalXS :members: -.. autoclass:: openmc.mgxs.mgxs.TransportXS +.. autoclass:: TransportXS :members: