Added basic structure for Python API docs and filled out docstrings for

openmc.cmfd module.
This commit is contained in:
Paul Romano 2015-06-01 12:08:45 +07:00
parent 471030c992
commit 11ab3b78aa
22 changed files with 306 additions and 180 deletions

View file

@ -0,0 +1,8 @@
.. _pythonapi_ace:
==========
ACE Format
==========
.. automodule:: openmc.ace
:members:

View file

@ -0,0 +1,8 @@
.. _pythonapi_cmfd:
====
CMFD
====
.. automodule:: openmc.cmfd
:members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_element:
=======
Element
=======
.. automodule:: openmc.element
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_executor:
========
Executor
========
.. automodule:: openmc.executor
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_filter:
======
Filter
======
.. automodule:: openmc.filter
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_geometry:
========
Geometry
========
.. automodule:: openmc.geometry
:members:
:undoc-members:

View file

@ -0,0 +1,32 @@
.. _pythonapi:
==========
Python API
==========
--------
Contents
--------
.. toctree::
:maxdepth: 1
ace
cmfd
element
executor
filter
geometry
material
mesh
nuclide
opencg_compatible
particle_restart
plots
settings
statepoint
summary
surface
tallies
trigger
universe

View file

@ -0,0 +1,9 @@
.. _pythonapi_material:
=========
Materials
=========
.. automodule:: openmc.material
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_mesh:
====
Mesh
====
.. automodule:: openmc.mesh
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_nuclide:
=======
Nuclide
=======
.. automodule:: openmc.nuclide
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_opencg_compatible:
====================
OpenCG Compatibility
====================
.. automodule:: openmc.opencg_compatible
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_particle_restart:
================
Particle Restart
================
.. automodule:: openmc.particle_restart
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_plots:
=====
Plots
=====
.. automodule:: openmc.plots
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_settings:
========
Settings
========
.. automodule:: openmc.settings
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_statepoint:
==========
Statepoint
==========
.. automodule:: openmc.statepoint
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_summary:
=======
Summary
=======
.. automodule:: openmc.summary
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_surface:
=======
Surface
=======
.. automodule:: openmc.surface
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_tallies:
=======
Tallies
=======
.. automodule:: openmc.tallies
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_trigger:
=======
Trigger
=======
.. automodule:: openmc.trigger
:members:
:undoc-members:

View file

@ -0,0 +1,9 @@
.. _pythonapi_universe:
========
Universe
========
.. automodule:: openmc.universe
:members:
:undoc-members: