87d5f5b9a9
* update pre-commit hook * upgrade pip with venv * update description and version * show url in publish environment * update versions * update versions, separate typing job * use dependabot grouped updates ignore upload/download-artifact until slsa updates * use sphinx.ext.extlinks instead of sphinx-issues * update dev dependencies * update editorconfig * update gitignore * update .readthedocs.yaml * license is txt, readme is md * update pyproject.toml add typed classifier add pyright config simplify urls * tox builds docs in place * update min test py version * add tox env to update all dev dependencies * update issue and pr templates * rename security docs page to not conflict with org policy file * simplify matrix
84 lines
1.8 KiB
ReStructuredText
84 lines
1.8 KiB
ReStructuredText
.. rst-class:: hide-header
|
|
|
|
Welcome to Flask
|
|
================
|
|
|
|
.. image:: _static/flask-horizontal.png
|
|
:align: center
|
|
|
|
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 `Werkzeug`_ WSGI toolkit, the `Jinja`_ template engine, and the
|
|
`Click`_ CLI toolkit. Be sure to check their documentation as well as Flask's when
|
|
looking for information.
|
|
|
|
.. _Werkzeug: https://werkzeug.palletsprojects.com
|
|
.. _Jinja: https://jinja.palletsprojects.com
|
|
.. _Click: https://click.palletsprojects.com
|
|
|
|
|
|
User's Guide
|
|
------------
|
|
|
|
Flask provides configuration and conventions, with sensible defaults, to get started.
|
|
This section of the documentation explains the different parts of the Flask framework
|
|
and how they can be used, customized, and extended. Beyond Flask itself, look for
|
|
community-maintained extensions to add even more functionality.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
installation
|
|
quickstart
|
|
tutorial/index
|
|
templating
|
|
testing
|
|
errorhandling
|
|
debugging
|
|
logging
|
|
config
|
|
signals
|
|
views
|
|
lifecycle
|
|
appcontext
|
|
reqcontext
|
|
blueprints
|
|
extensions
|
|
cli
|
|
server
|
|
shell
|
|
patterns/index
|
|
web-security
|
|
deploying/index
|
|
async-await
|
|
|
|
|
|
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
|
|
----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
design
|
|
extensiondev
|
|
contributing
|
|
license
|
|
changes
|