TurboGears 2.x Docs repository
Shell
Latest commit eded0dd Jul 3, 2017 @amol- amol- Version 2.3.11
Permalink
Failed to load latest commit information.
docs Version 2.3.11 Jul 3, 2017
.gitignore Moving forward toward refactoring documentation Dec 19, 2012
.hgignore Committing work from Christoph to implement new theme for 2.1 docs. Apr 5, 2011
.hgtags
README.rst move README.rst to the root of repository Apr 28, 2015
checkupdates Tell checkupdates to check default repository too. Sep 26, 2009
requirements.txt Version 2.3.11 Jul 3, 2017

README.rst

TurboGears 2.3 Documentation Source

This is the source of the latest Turbogears 2.3 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.3 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.