next up previous index
Next: Using Python Macros Up: Writing Documentation Previous: Writing Documentation   Index

The Reference Manual and User Guide

The Opus and UrbanSim 4 documentation in this guide follows the Python documentation standards (or at least it's supposed to), and is written using LATEX and the Python documentation macros. The latest version of this Guide (as a pdf file), and the Opus tutorial, is automatically posted on the UrbanSim website at http://www.urbansim.org/ whenever a new version of any of the manual's components is checked in to the CVS repository. There is also an html version produced using latex2html, also produced by the same build script.

The Guide includes a table of contents and a (currently rudimentary) index. The Adobe pdf reader also includes a nice full-text-search tool that can, of course, be used on this manual when reading the pdf version online.

See also:

Documenting Python (http://docs.python.org/doc/doc.html): This document describes how to document Python using the LATEX macros developed for the purpose.

Python Documentation Download page (http://docs.python.org/download.html): The download page provides links for downloading the Python documentation in various formats, in particular LATEX source. The macros in the texinputs/ subdirectory there have been copied into the docs/latex directory (and occasionally modified) for use in formatting this Guide. Other manuals there are also useful as examples of using the macros.


next up previous index
Next: Using Python Macros Up: Writing Documentation Previous: Writing Documentation   Index
info (at) urbansim.org