TurboGears 2.x Docs repository
Pull request Compare This branch is 267 commits behind TurboGears:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
book
docs
.gitignore
.hgignore
.hgtags
checkupdates
requirements.txt

README.txt

TurboGears 2.1 Documentation Source
===================================

This is the source of the latest Turbogears 2.1 documentation effort.

The docs are written in reStructuredText_ (.rst files), a simple markup 
language often used to document python projects.   
We use Sphinx_ to generate html from the rst files.

Since this documentation is for the 2.1 development branch of Turbogears,
we also need to download the source in order to generate documentation from 
the modules.

If you are interested in helping with the new turbogears docs, we recommend 
you touch base with mpedersen on the IRC channel #turbogears.  He appreciates
any help you can give, and can help you get setup so he can more easily
incorporate your modifications.   In :ref:`building_docs`, we give detailed
information on how to setup an environment for building the docs.   Using
this guide will give you a jumpstart for participating in the effort.


Building Docs
-------------

Please see the file :ref:`building_docs` for more information.

For those of you reading this outside of a restructed text setup, please view
the file building_docs.rst for more information.

.. _Sphinx: http://sphinx.pocoo.org/