flask/docs/index.rst

92 lines
2.0 KiB
ReStructuredText
Raw Normal View History

2019-01-06 06:59:25 +08:00
.. rst-class:: hide-header
Welcome to Flask
================
2018-09-17 23:35:28 +08:00
.. image:: _static/flask-logo.png
:alt: Flask: web development, one drop at a time
2018-09-17 23:35:28 +08:00
:align: center
:target: https://palletsprojects.com/p/flask/
Welcome to Flask's documentation. Get started with :doc:`installation`
and then get an overview with the :doc:`quickstart`. There is also a
more detailed :doc:`tutorial/index` that shows how to create a small but
complete application with Flask. Common patterns are described in the
:doc:`patterns/index` section. The rest of the docs describe each
component of Flask in detail, with a full reference in the :doc:`api`
section.
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
- `Jinja documentation <https://jinja.palletsprojects.com/>`_
2019-06-24 06:37:51 +08:00
- `Werkzeug documentation <https://werkzeug.palletsprojects.com/>`_
2010-04-16 18:21:31 +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
debugging
2019-06-24 03:27:25 +08:00
logging
config
signals
views
appcontext
reqcontext
blueprints
extensions
cli
server
shell
patterns/index
deploying/index
becomingbig
async_await
2019-06-24 03:27:25 +08:00
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
extensiondev
contributing
2021-02-25 02:09:38 +08:00
license
changes