Get GROUP_STRUCTURES to show up in documentation

This commit is contained in:
Paul Romano 2018-11-07 07:36:08 -06:00
parent a46aab8365
commit 82f61a2a33
3 changed files with 13 additions and 13 deletions

View file

@ -1,7 +0,0 @@
{{ fullname }}
{{ underline }}
.. currentmodule:: {{ module }}
.. automodule:: {{ objname }}
:members:

View file

@ -5,13 +5,21 @@
Energy Groups
-------------
Module Variables
++++++++++++++++
.. autodata:: openmc.mgxs.GROUP_STRUCTURES
:annotation:
Classes
+++++++
.. autosummary::
:toctree: generated
:nosignatures:
:template: myclass.rst mymodulevar.rst
:template: myclass.rst
openmc.mgxs.EnergyGroups
openmc.mgxs.GROUP_STRUCTURES
Multi-group Cross Sections
--------------------------

View file

@ -5,11 +5,10 @@ from openmc.mgxs.mgxs import *
from openmc.mgxs.mdgxs import *
GROUP_STRUCTURES = {}
"""Commonly used energy group structures, including "CASMO-X" (where X
is 2, 4, 8, 16, 25, 40 or 70) from the [CASMO]_ lattice physics code.
"""Dictionary of commonly used energy group structures, including "CASMO-X" (where X
is 2, 4, 8, 16, 25, 40 or 70) from the CASMO_ lattice physics code.
.. [CASMO] J. Rhodes, K. Smith, and D. Lee, "CASMO-5 Development and
Applications", *Proc. ANS Topical Meeting on Reactor Physics* (2006).
.. _CASMO: https://www.studsvik.com/SharepointFiles/CASMO-5%20Development%20and%20Applications.pdf
"""