Merge pull request #9 from paulromano/mgxs-doc-fixes

Fix documentation problems
This commit is contained in:
Will Boyd 2015-10-28 08:45:18 -07:00
commit b9eef474d8
7 changed files with 76 additions and 20 deletions

View file

@ -4,5 +4,63 @@
Multi-Group Cross Sections
==========================
.. automodule:: openmc.mgxs.mgxs
:members: 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:: AbsorptionXS
:members:
.. autoclass:: CaptureXS
:members:
.. autoclass:: Chi
:members:
.. autoclass:: FissionXS
:members:
.. autoclass:: NuFissionXS
:members:
.. autoclass:: NuScatterXS
:members:
.. autoclass:: NuScatterMatrixXS
:members:
.. autoclass:: ScatterXS
:members:
.. autoclass:: ScatterMatrixXS
:members:
.. autoclass:: TotalXS
:members:
.. autoclass:: TransportXS
:members:

View file

@ -1,8 +1,8 @@
.. _pythonapi_openmc_mgxs:
.. _pythonapi_opencg_compatible:
==========================
Multi-Group Cross Sections
==========================
====================
OpenCG Compatibility
====================
.. automodule:: openmc.mgxs.mgxs
.. automodule:: openmc.opencg_compatible
:members: