Menu

Tree [r5423] / trunk / py4science / examples / sphinx_template /
 History

HTTPS access


File Date Author Commit
 _static 2008-06-03 jdh2358 [r5379] added sphinx template for doc unit
 _templates 2008-06-03 jdh2358 [r5379] added sphinx template for doc unit
 build 2008-06-03 jdh2358 [r5379] added sphinx template for doc unit
 model 2008-06-03 jdh2358 [r5379] added sphinx template for doc unit
 simulations 2008-06-03 jdh2358 [r5379] added sphinx template for doc unit
 README.txt 2008-06-03 jdh2358 [r5379] added sphinx template for doc unit
 conf.py 2008-06-03 jdh2358 [r5379] added sphinx template for doc unit
 index.rst 2008-06-03 jdh2358 [r5379] added sphinx template for doc unit
 make.py 2008-06-03 jdh2358 [r5379] added sphinx template for doc unit

Read Me

sphinx template sampledoc
=========================

This is the top level build directory for the sphinx sampledoc
documentation.  All of the documentation is written using sphinx, a
python documentation system built on top of ReST.  This directory
contains


* model - A document describing a model

* simulations - A document describing the simulations -- contains a
  code subdir with python scripts and a make.py file to build them
  into PNGs

* make.py - the build script to build the html or PDF docs.  Do
  `python make.py html` or `python make.py latex` for PDF

* index.rst - the top level include document for sampledocs document

* conf.py - the sphinx configuration

* _static - used by the sphinx build system

* _templates - used by the sphinx build system