[ET Trac] [Einstein Toolkit] #122: Code documentation

[Einstein Toolkit]

#122: Code documentation
--------------------------+-------------------------------------------------
  Reporter:  hinder       |       Owner:  mthomas
      Type:  enhancement  |      Status:  new    
  Priority:  minor        |   Milestone:         
 Component:  SimFactory   |     Version:         
Resolution:               |    Keywords:         
--------------------------+-------------------------------------------------

Comment (by hinder):

 Committed.  I don't think you can generate an index.html file.  However,
 the sim.html file is a good starting point, and acts as a kind of index.
 There is another tool which works in a similar way to the html generation
 of pydoc called "pythondoc".  We could see if that makes nicer-looking
 output.  I would say the next step would be to add docstrings to all the
 functions.

-- 
Ticket URL: <https://trac.einsteintoolkit.org/ticket/122#comment:6>
Einstein Toolkit <http://einsteintoolkit.org>
The Einstein Toolkit