======================
Documentation Overview
======================

Welcome to the Werkzeug documentation.


Reference
=========

Documentation regarding the Werkzeug modules:

- `Installing Werkzeug <installation.txt>`_

- `Important Terms <terms.txt>`_ --- read this before reading the
  documentation

- `Tutorial <tutorial.txt>`_ --- getting started with Werkzeug

- `Unicode <unicode.txt>`_ --- short introduction into unicode in python
  and how Werkzeug encodes and decodes data.

- `Wrappers <wrappers.txt>`_ --- request and response objects

- `Routing System <routing.txt>`_ --- a powerful URL dispatcher
  and builder

- `Mini Templates <templates.txt>`_ --- a minimal templating system

- `Management Script Utilities <script.txt>`_ --- tools to write simple
  management scripts

- `Test Utilities <test.txt>`_ --- unittest support tools

- `HTTP Exceptions <exceptions.txt>`_ --- exceptions for HTTP

- `Utilities <utils.txt>`_ --- useful classes and functions

- `Context Locals <local.txt>`_ --- a WSGI centric version of `thread.local`.

- `Debugging System <debug.txt>`_ --- an interactive debugger.

- `Serving Applications <serving.txt>`_ --- serving WSGI applications.

- `API Stability <api_stability.txt>`_ --- API stability


General Development Information
===============================

This part of the documentation mainly explains how to develop WSGI
applications.  This is also interesting if you don't want to use
Werkzeug but other WSGI utilities; the ideas are the same.

- `How WSGI Works <wsgihowto.txt>`_ --- short introduction to WSGI and
  Werkzeug.

- `Organizing Code <organizing.txt>`_ --- gives you an idea how you can
  organize your code when using Werkzeug.

- `Other Libraries <libraries.txt>`_ --- links to other libraries you
  can use with Werkzeug.

- `Deploying WSGI Applications <deploying.txt>`_ --- ready for production?
  This page covers all the details you have to know to deploy your
  application on various webservers.


.. _TinyURL: http://tinyurl.com/
