Tree [r7423] / tags / 1.9.7a4 / docs /
History



File Date Author Commit
_static 2008-08-10 splee [r5120] Updated style for sphinx generated tg2.0 docs
_templates 2008-05-31 mramm [r4631] small layout uppdate
main 2008-08-29 sanjiv [r5299] Added TileCache Tutorial
modules 2008-08-11 mramm [r5134] Doc typos fixed, and a bit more config documena...
project_code 2008-08-27 lmacken [r5265] More s/tg.config/tg.configuration/ changes
Makefile 2008-04-01 fredlin [r4322] update doc make file
README.txt 2008-06-11 mramm [r4699] Fixint Restructured text errors in the docs.
conf.py 2008-07-14 brunojm [r4953] test option added and some fixes
get_tgdoc.py 2008-04-08 fredlin [r4352] doc update
index.rst 2008-08-21 sanjiv [r5188] Added module docs for tg.ext.geo
tgext.py 2008-07-23 brunojm [r5023] replace '/' to `os.sep`

Read Me

Documentation Generation Guide
==================================

DOC Generation
--------------

Make sure that you have followed the instructions in top-level ``INSTALL.txt``
file to install TurboGears 2.

You also need to install Sphinx_ to generate the TurboGears documentation from
docs.turbogears.org::

    $ easy_install Sphinx

For the following, change to the ``docs`` directory below the top-level
TurboGears 2 source directory.

Then run ``get_tgdoc.py`` script to fetch rest docs from TurboGears wiki::

    $ python get_tgdoc.py

Finally, run ``make <builder>`` to generate docs::

    $ make html

.. _sphinx: http://sphinx.pocoo.org/
.. _sourceforge: http://sourceforge.net/project/showfiles.php?group_id=32455
.. _reStructuredText: http://docutils.sourceforge.net/rst.html