2010-04-06 16:02:14 +02:00
|
|
|
Welcome to Flask
|
|
|
|
|
================
|
|
|
|
|
|
2010-04-10 15:49:15 +02:00
|
|
|
.. image:: _static/logo-full.png
|
|
|
|
|
:alt: The Flask Logo with Subtitle
|
2010-04-18 13:15:00 +02:00
|
|
|
:class: floatingflask
|
2010-04-10 15:49:15 +02:00
|
|
|
|
2010-04-12 08:15:35 +08:00
|
|
|
Welcome to Flask's documentation. This documentation is divided in
|
2010-04-09 13:40:05 +02:00
|
|
|
different parts. I would suggest to get started with the
|
2010-04-15 02:21:46 +02:00
|
|
|
:ref:`installation` and then heading over to the :ref:`quickstart`.
|
|
|
|
|
Besides the quickstart there is also a more detailed :ref:`tutorial` that
|
|
|
|
|
shows how to create a complete (albeit small) application with Flask. If
|
|
|
|
|
you rather want to dive into all the internal parts of Flask, check out
|
|
|
|
|
the :ref:`api` documentation. Common patterns are described in the
|
2010-04-09 13:40:05 +02:00
|
|
|
:ref:`patterns` section.
|
2010-04-06 16:02:14 +02:00
|
|
|
|
2010-04-16 12:21:31 +02:00
|
|
|
Flask also depends on two external libraries: the `Jinja2`_ template
|
|
|
|
|
engine and the `Werkzeug`_ WSGI toolkit. both of which are not documented
|
|
|
|
|
here. If you want to dive into their documentation check out the
|
|
|
|
|
following links:
|
|
|
|
|
|
|
|
|
|
- `Jinja2 Documentation <http://jinja.pocoo.org/2/documentation/>`_
|
|
|
|
|
- `Werkzeug Documentation <http://werkzeug.pocoo.org/documentation/>`_
|
|
|
|
|
|
|
|
|
|
.. _Jinja2: http://jinja.pocoo.org/2/
|
|
|
|
|
.. _Werkzeug: http://werkzeug.pocoo.org/
|
|
|
|
|
|
2010-04-20 20:21:01 +02:00
|
|
|
User's Guide
|
|
|
|
|
------------
|
2010-04-16 12:21:31 +02:00
|
|
|
|
|
|
|
|
This part of the documentation is written text and should give you an idea
|
|
|
|
|
how to work with Flask. It's a series of step-by-step instructions for
|
|
|
|
|
web development.
|
|
|
|
|
|
2010-04-06 16:02:14 +02:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
2010-04-10 15:49:15 +02:00
|
|
|
foreword
|
2010-04-09 01:32:39 +02:00
|
|
|
installation
|
|
|
|
|
quickstart
|
2010-04-18 13:15:00 +02:00
|
|
|
tutorial/index
|
2010-04-16 12:21:31 +02:00
|
|
|
testing
|
2010-04-18 13:35:40 +02:00
|
|
|
patterns/index
|
2010-04-19 11:23:44 +02:00
|
|
|
deploying/index
|
2010-04-10 15:49:15 +02:00
|
|
|
becomingbig
|
2010-04-20 20:21:01 +02:00
|
|
|
|
|
|
|
|
Additional Notes
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
Design notes, legal information and changelog are here for the interested:
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
2010-04-18 15:44:06 +02:00
|
|
|
design
|
2010-04-20 13:29:54 +02:00
|
|
|
license
|
2010-04-20 20:21:01 +02:00
|
|
|
changelog
|
2010-04-16 12:21:31 +02:00
|
|
|
|
2010-04-20 20:21:01 +02:00
|
|
|
API Reference
|
|
|
|
|
-------------
|
2010-04-16 12:21:31 +02:00
|
|
|
|
|
|
|
|
If you are looking for information on a specific function, class or
|
|
|
|
|
method, this part of the documentation is for you:
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
api
|
