mirror of https://github.com/mitsuhiko/flask.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
71 lines
1.8 KiB
71 lines
1.8 KiB
:orphan: |
|
|
|
Welcome to Flask |
|
================ |
|
|
|
.. image:: _static/logo-full.png |
|
:alt: The Flask Logo with Subtitle |
|
:class: floatingflask |
|
|
|
Welcome to Flask's documentation. This documentation is divided in |
|
different parts. I would suggest to get started with the |
|
: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 |
|
:ref:`patterns` section. |
|
|
|
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/ |
|
|
|
User's Guide |
|
------------ |
|
|
|
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. |
|
|
|
.. toctree:: |
|
:maxdepth: 2 |
|
|
|
foreword |
|
installation |
|
quickstart |
|
tutorial/index |
|
testing |
|
errorhandling |
|
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 |
|
license |
|
changelog
|
|
|