Skip to content

Docnotes

Jump to bottom Edit New page
ttrainor edited this page Jan 8, 2012 · 2 revisions

Standalone Documentation Styles

  • For documentation files/pages use the reStructuredText (rst) format
  • Doc files should be stored under tdl/doc
  • Images can be stored in tdl/doc/images
  • If we move all (or most) of these wiki pages to rst files in tdl/doc then we can use Sphinx to generate html output and post these as static web pages (same as xraylarch)... Before we go this route we can use the wiki to clean up / correct the documentation. When things seem relatively stable we can move the wiki pages to the doc directory.
Add a custom footer
Add a custom sidebar
Clone this wiki locally