Commit graph

341 commits

Author SHA1 Message Date
Grey Li
cc297f7312 Remove the mention of Flask-Uploads in uploading docs 2021-08-14 05:10:45 -07:00
Frank Yu
877ba21447 Omit the type attribute of script tag 2021-07-07 15:18:04 +08:00
Hugo Montenegro
89652cece5 Update celery.rst
small typo
2021-06-08 19:01:07 +02:00
Grey Li
13ee3c63cf Fix view decorators docs 2021-05-21 12:11:03 +00:00
David Lord
39d978f42b use Jinja's tojson filter 2021-02-01 22:48:09 -08:00
David Lord
26bb6b1c56 move send_file and send_from_directory to Werkzeug
The implementations were moved to Werkzeug, Flask's functions become
wrappers around Werkzeug to pass some Flask-specific values.

cache_timeout is renamed to max_age. SEND_FILE_MAX_AGE_DEFAULT,
app.send_file_max_age_default, and app.get_send_file_max_age defaults
to None. This tells the browser to use conditional requests rather than
a 12 hour cache.

attachment_filename is renamed to download_name, and is always sent if
a name is known.

Deprecate helpers.safe_join in favor of werkzeug.utils.safe_join.

Removed most of the send_file tests, they're tested in Werkzeug.

In the file upload example, renamed the uploaded_file view to
download_file to avoid a common source of confusion.
2020-11-05 09:27:52 -08:00
Grey Li
6219702269 Add command switch tabs for Bash, CMD and Powershell with sphinx-tabs (#3714)
* Enable Sphinx extension sphinx-tabs

* Add command tabs for all export commands

* Add command tabs for all venv commands

Fix trim spaces
2020-10-15 14:08:37 -07:00
miquelvir
cd5be90d5b fix grammar (#3769) 2020-09-28 06:21:59 -07:00
jackwardell
79bd55cedf consolidate error handling docs
Remove apierrors.rst and errorpages.rst from patterns and integrate the
content into errorhandling.rst, along with other changes and extra
content.
2020-07-24 09:15:43 -07:00
David Lord
0c8c96122b fix typo 2020-07-08 08:26:21 -07:00
Armin Ronacher
40d6d107c5 Some small doc fixes 2020-07-08 15:53:43 +02:00
iomintz
1350049c9d [docs] streaming contents: use app.response_class
Examples should use app.response_class to encourage code that doesn't need to be changed should the response class be customized later on.
2020-06-17 22:00:35 -05:00
Jeff Widman
1d52c00957 Fix docs link for Flask-Uploads 2020-05-08 12:42:52 -07:00
David Lord
1de5873d66 remove unused ref directives
replace page refs with doc directives
2020-04-04 12:57:14 -07:00
David Lord
f5038c4c39 f-strings everywhere 2020-04-04 12:10:00 -07:00
David Lord
c0c76bd651 remove Python 2 from docs 2020-04-04 12:05:44 -07:00
David Lord
9e0fe3efb0 Merge remote-tracking branch 'origin/1.1.x' 2020-02-10 18:41:07 -08:00
yingshaoxo
089a379b97 pass static_url_path along with static_folder 2020-02-10 18:33:32 -08:00
David Lord
72fe9e541c Merge pull request #3406 from erfanio/f-string-docs
Change docs to use f-strings
2019-11-18 19:09:30 -08:00
Thiago J. Barbalho
a327136305 Fix typo 2019-11-02 20:56:35 +00:00
erfanio
96524db988 Change docs to use f-strings 2019-10-26 17:19:00 +11:00
David Lord
d3581e97c4 Merge branch '1.1.x' 2019-09-23 08:38:29 -07:00
David Lord
d5a739fae5 Merge branch '1.0.x' into 1.1.x 2019-09-23 08:38:11 -07:00
David Lord
4504c6d7b8 update patterns, snippets, extensions docs 2019-09-23 08:19:40 -07:00
Constantin
1c383fc13f fix typo: base on -> based on 2019-08-25 20:33:41 +02:00
Eido95
0f96fec7bc docs: Change max content length value to megabyte
16 * 1024 * 1024 = 16 MiB (Mebibyte)
16 * 1000 * 1000 = 16 MB (Megabyte)

The example is in megabytes, not in mebibytes.
2019-08-13 11:02:56 +03:00
Csirmaz Bendegúz
59ef0883f7 Fix typo in urlprocessors.rst 2019-08-01 12:58:07 -07:00
David Lord
ff0c92a1c7 Merge branch '1.0.x' 2019-06-23 16:57:52 -07:00
David Lord
363741ec69 fix docks linkcheck 2019-06-23 15:37:51 -07:00
David Lord
3ab901146c reword api error section 2019-06-12 11:02:53 -07:00
Logan Wright
bd6111273b adds api error handling documentation 2019-06-12 10:54:12 -07:00
Jon S. Stumpf
8577b347a7 add pre-commit config for flake8 2019-06-01 09:13:46 -04:00
David Lord
316caad5db Merge branch '1.0.x' 2019-05-16 12:18:36 -07:00
Martin Michlmayr
93f03eabbb Fix typos in the documentation 2019-02-24 10:40:23 +00:00
David Lord
091ada7da3 remove encoding from method override pattern 2019-01-07 13:09:36 -08:00
David Lord
39a8efe484 Merge branch '1.0-maintenance' 2019-01-06 15:46:33 -08:00
David Lord
141373fdd0 simplify mongoengine doc, redirect from mongokit 2019-01-06 15:42:08 -08:00
Igor Ghisi
1643efd81f Replace MongoKit by MongoEngine on docs
Docs chapter "Patterns for Flask" has a section dedicated to MongoKit,
but MongoKit lib seems unmaintained and is not compatible with recent
versions of PyMongo.

This commit replaces MongoKit guide with a new one using MongoEngine.

Closes #2907
2019-01-06 15:12:53 -08:00
Stephon Harris
ee861266dc Adding conjunction where for clarification 2019-01-06 15:05:54 -08:00
nathanbegbie
7b00a51acc Update docs on larger applications wrt tutorial
The wording of the docs makes it sound like the tutorials use the simple structure for a flask application, which they no longer do.
This commit re-words the docs to make it clearer.
2019-01-06 14:53:03 -08:00
Aly Sivji
4ceeb04a1c Add SPA pattern to docs 2019-01-06 06:19:55 -08:00
David Lord
ca27661d8a Merge branch '1.0-maintenance' 2019-01-05 15:12:17 -08:00
Andrew Crouse
b2bcf461c4 Update documentation for users to use flask-caching instead of the deprecated Werkzeug cache 2018-11-13 14:03:27 -05:00
Aditya
fa50bdd372 Use https for external links wherever possible 2018-10-27 17:58:45 +05:30
jangjunha
f112dc0aed Fix deferred callback doc 2018-10-26 00:33:12 +09:00
Grey Li
95008cf43d Add prefix for all commands in documentation (#2877)
* Add prefix for commands in docs

* Add prefix for commands in example's README
2018-09-09 17:41:56 +09:00
Gabriel Saldanha
78530d2322 🎨 Use set literal instead of set method 2018-06-27 08:58:26 -03:00
Yao Long
ddeb9c370f document error on fileupload
after file uploaded, it should redirect for uploaded_file page instead
of upload page
2018-04-27 11:04:35 -07:00
David Lord
010156c80a use theme provided by pallets-sphinx-themes 2018-04-18 12:05:31 -07:00
David Lord
84e9ff3853 clean up js example 2018-04-12 12:17:14 -07:00