2019-01-06 06:59:25 +08:00
|
|
|
.. rst-class:: hide-header
|
2010-05-24 14:38:28 +08:00
|
|
|
|
2010-04-06 22:02:14 +08:00
|
|
|
Welcome to Flask
|
|
|
|
|
================
|
|
|
|
|
|
2019-06-24 03:27:25 +08:00
|
|
|
.. image:: _static/flask-logo.png
|
2018-02-07 22:56:14 +08:00
|
|
|
:alt: Flask: web development, one drop at a time
|
2019-01-06 06:59:25 +08:00
|
|
|
:align: center
|
|
|
|
|
:target: https://palletsprojects.com/p/flask/
|
2010-04-10 21:49:15 +08:00
|
|
|
|
2018-02-07 22:56:14 +08:00
|
|
|
Welcome to Flask's documentation. Get started with :ref:`installation`
|
|
|
|
|
and then get an overview with the :ref:`quickstart`. There is also a
|
|
|
|
|
more detailed :ref:`tutorial` that shows how to create a small but
|
|
|
|
|
complete application with Flask. Common patterns are described in the
|
2018-04-13 13:54:11 +08:00
|
|
|
:ref:`patterns` section. The rest of the docs describe each component of
|
2018-02-07 22:56:14 +08:00
|
|
|
Flask in detail, with a full reference in the :ref:`api` section.
|
2010-04-06 22:02:14 +08:00
|
|
|
|
2018-02-07 22:56:14 +08:00
|
|
|
Flask depends on the `Jinja`_ template engine and the `Werkzeug`_ WSGI
|
|
|
|
|
toolkit. The documentation for these libraries can be found at:
|
2010-04-16 18:21:31 +08:00
|
|
|
|
2018-02-07 22:56:14 +08:00
|
|
|
- `Jinja documentation <http://jinja.pocoo.org/docs>`_
|
2019-06-24 06:37:51 +08:00
|
|
|
- `Werkzeug documentation <https://werkzeug.palletsprojects.com/>`_
|
2010-04-16 18:21:31 +08:00
|
|
|
|
2018-02-07 22:56:14 +08:00
|
|
|
.. _Jinja: https://www.palletsprojects.com/p/jinja/
|
|
|
|
|
.. _Werkzeug: https://www.palletsprojects.com/p/werkzeug/
|
2010-04-16 18:21:31 +08:00
|
|
|
|
2019-06-24 03:27:25 +08:00
|
|
|
|
|
|
|
|
User's Guide
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
This part of the documentation, which is mostly prose, begins with some
|
|
|
|
|
background information about Flask, then focuses on step-by-step
|
|
|
|
|
instructions for web development with Flask.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
foreword
|
|
|
|
|
advanced_foreword
|
|
|
|
|
installation
|
|
|
|
|
quickstart
|
|
|
|
|
tutorial/index
|
|
|
|
|
templating
|
|
|
|
|
testing
|
|
|
|
|
errorhandling
|
|
|
|
|
logging
|
|
|
|
|
config
|
|
|
|
|
signals
|
|
|
|
|
views
|
|
|
|
|
appcontext
|
|
|
|
|
reqcontext
|
|
|
|
|
blueprints
|
|
|
|
|
extensions
|
|
|
|
|
cli
|
|
|
|
|
server
|
|
|
|
|
shell
|
|
|
|
|
patterns/index
|
|
|
|
|
deploying/index
|
|
|
|
|
becomingbig
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
API Reference
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Additional Notes
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
Design notes, legal information and changelog are here for the interested.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
design
|
|
|
|
|
htmlfaq
|
|
|
|
|
security
|
|
|
|
|
unicode
|
|
|
|
|
extensiondev
|
|
|
|
|
styleguide
|
|
|
|
|
upgrading
|
|
|
|
|
changelog
|
|
|
|
|
license
|
|
|
|
|
contributing
|
