Skip to content
Browse files

Added stubs in documentation for njoy module.

  • Loading branch information...
1 parent 0645c31 commit dbf9d645f60110dba96f7160ff5aeba0455bbedb @paulromano paulromano committed Jun 1, 2012
Showing with 43 additions and 0 deletions.
  1. +1 −0 docs/source/libref/index.rst
  2. +24 −0 docs/source/libref/njoy.rst
  3. +1 −0 docs/source/usersguide/index.rst
  4. +17 −0 docs/source/usersguide/njoy.rst
View
1 docs/source/libref/index.rst
@@ -13,6 +13,7 @@ The following modules and sub-packages are discussed:
data
material
bins
+ njoy
cccc
ace
ensdf
View
24 docs/source/libref/njoy.rst
@@ -0,0 +1,24 @@
+.. _pyne_njoy:
+
+===================================
+NJOY Automation -- :mod:`pyne.njoy`
+===================================
+
+.. currentmodule:: pyne.njoy
+
+.. automodule:: pyne.njoy
+
+All functionality may be found in the ``njoy`` package::
+
+ from pyne import njoy
+
+The information below represents the complete specification of the classes in
+the njoy module. For examples of usage, please refer to the User's Guide entry
+for :ref:`usersguide_njoy`.
+
+************
+Njoy99 Class
+************
+
+.. autoclass:: Njoy99
+ :members:
View
1 docs/source/usersguide/index.rst
@@ -11,6 +11,7 @@ essential aspects of using PyNE to do nuclear engineering.
nucname
material
+ njoy
cccc
ace
origen22
View
17 docs/source/usersguide/njoy.rst
@@ -0,0 +1,17 @@
+.. _usersguide_njoy:
+
+===============
+NJOY Automation
+===============
+
+.. currentmodule:: pyne.njoy
+
+.. automodule:: pyne.njoy
+
+For a complete specification for the classes in the ``njoy`` module, please
+refer to the Library Reference entry for :ref:`pyne_njoy`.
+
+***************************
+Example Use of Njoy99 Class
+***************************
+

0 comments on commit dbf9d64

Please sign in to comment.
Something went wrong with that request. Please try again.