[ET Trac] [Einstein Toolkit] #502: SimFactory user-guide should be available and updated automatically

[Einstein Toolkit]

#502: SimFactory user-guide should be available and updated automatically
-------------------------+--------------------------------------------------
 Reporter:  hinder       |       Owner:  knarf
     Type:  enhancement  |      Status:  new  
 Priority:  major        |   Milestone:       
Component:  SimFactory   |     Version:       
 Keywords:               |  
-------------------------+--------------------------------------------------
 SimFactory has an incomplete user guide in the doc/userguide directory.
 This is developed using Sphinx, which is a Python framework for writing
 documentation.  You need to install sphinx to generate this documentation.
 This can be done using something similar to the following:

   export PYTHONPATH=/home/ianhin/software/python
   export PATH=/home/ianhin/software/python/:$PATH
   hash -r
   easy_install --install-dir ~/software/python sphinx

 Then go into the simfactory/doc/userguide directory and type:

   ./autogen
   make html

 to generate HTML documentation (type just "make" to see the other possible
 targets like PDF etc).

 This should be regenerated on any commit to the SimFactory/doc/userguide
 directory and copied to a web-accessible location for inclusion on
 simfactory.org.

-- 
Ticket URL: <https://trac.einsteintoolkit.org/ticket/502>
Einstein Toolkit <http://einsteintoolkit.org>
The Einstein Toolkit