Commit Graph

374 Commits

Author SHA1 Message Date
yingshaoxo 7e068145df
pass static_url_path along with static_folder 2020-02-10 18:33:32 -08:00
David Lord 2659f0a5e6
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 4f6b310513
Fix typo 2019-11-02 20:56:35 +00:00
erfanio 07caa44224 Change docs to use f-strings 2019-10-26 17:19:00 +11:00
David Lord 40eadfc52a
Merge branch '1.1.x' 2019-09-23 08:38:29 -07:00
David Lord 746d9181d7
Merge branch '1.0.x' into 1.1.x 2019-09-23 08:38:11 -07:00
David Lord e01b68e7ee
update patterns, snippets, extensions docs 2019-09-23 08:19:40 -07:00
Constantin b839beb23d
fix typo: base on -> based on 2019-08-25 20:33:41 +02:00
Eido95 b33e89935a
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 28ffe15349
Fix typo in urlprocessors.rst 2019-08-01 12:58:07 -07:00
David Lord 1351d0a565
Merge branch '1.0.x' 2019-06-23 16:57:52 -07:00
David Lord cb6272ccc8
fix docks linkcheck 2019-06-23 15:37:51 -07:00
David Lord 4b519f0e33
reword api error section 2019-06-12 11:02:53 -07:00
Logan Wright 7bc965fada
adds api error handling documentation 2019-06-12 10:54:12 -07:00
Jon S. Stumpf 549fed29ea
add pre-commit config for flake8 2019-06-01 09:13:46 -04:00
David Lord 2236ba980c
Merge branch '1.0.x' 2019-05-16 12:18:36 -07:00
Martin Michlmayr 7b88b35747
Fix typos in the documentation 2019-02-24 10:40:23 +00:00
David Lord 2c29495e6d
remove encoding from method override pattern 2019-01-07 13:09:36 -08:00
David Lord ac6746d1be
Merge branch '1.0-maintenance' 2019-01-06 15:46:33 -08:00
David Lord edef8cb38b
simplify mongoengine doc, redirect from mongokit 2019-01-06 15:42:08 -08:00
Igor Ghisi 4e280b4142
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 ab7f9e735f
Adding conjunction where for clarification 2019-01-06 15:05:54 -08:00
nathanbegbie b8e461e3d1
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 2b74cf9f2d
Add SPA pattern to docs 2019-01-06 06:19:55 -08:00
David Lord f7d50d4b67
Merge branch '1.0-maintenance' 2019-01-05 15:12:17 -08:00
Andrew Crouse aec0cdc016
Update documentation for users to use flask-caching instead of the deprecated Werkzeug cache 2018-11-13 14:03:27 -05:00
Aditya f05625eb82 Use https for external links wherever possible 2018-10-27 17:58:45 +05:30
jangjunha eef6c34b57 Fix deferred callback doc 2018-10-26 00:33:12 +09:00
Grey Li 21b0aa6dd8 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 c5af1be70f 🎨 Use set literal instead of set method 2018-06-27 08:58:26 -03:00
Yao Long 9b6878af5a
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 49a38ed999
use theme provided by pallets-sphinx-themes 2018-04-18 12:05:31 -07:00
David Lord 1e84c67beb
clean up js example 2018-04-12 12:17:14 -07:00
David Lord fce1885f76
add javascript ajax example 2018-04-12 11:06:02 -07:00
Grey Li 2f9be68a81
Add tips for 413 connection reset issue 2018-04-09 01:30:15 -07:00
David Lord c3dd7b8e4c
rewrite tutorial docs and example 2018-04-09 00:53:25 -07:00
Nickatak a9646716d2 Fix typo in example. 2018-01-14 16:02:43 -08:00
Armin Ronacher 2433522d29
Add Support for FLASK_ENV (#2570)
This introduces environments to Flask
2018-01-06 17:07:56 +01:00
Grey Li 94fd3edf31
Docs: Update CLI for factory pattern 2017-12-20 20:50:45 +08:00
Harry Moreno 2d2c0169d4
Fix docs, how to get db connection in pattern
The docs are inaccurately suggestion a db connection would be available at `g.db`, after calling `get_db()` a connection will be available at `g._database` but even then I think instructing the user to use `get_db()` is the best way forward.
2017-12-08 15:18:02 -05:00
Bogdan Alexandru Marginean b89cf95816 Update appfactories.rst 2017-10-19 22:32:47 +03:00
Mrn Om c352714478 Fix grammar/typos 2017-10-11 16:47:26 +03:00
David Lord 417bc336de
egg_info -R flag is gone 2017-07-27 07:32:03 -07:00
David Lord 8207b1563e
fix formatting
-R is no longer an egg_info option
closes #2400
[ci skip]
2017-06-28 19:55:39 -07:00
David Lord 465922e5f1
clean up secret key docs
consistent key across docs and examples
consistent key across tests, set in conftest
2017-06-28 07:58:06 -07:00
David Lord d5a88bf0d3
explain when to use a task queue
remove deprecated abstract attr from celery
add explanation of example task
[ci skip]
2017-05-15 12:40:09 -07:00
David Lord f13e3fc352
Merge branch 'master' into celery-documentation 2017-05-15 12:17:09 -07:00
David Lord cc59f2b204
clean up deferred callback doc
remove doc about writing after_this_request
[ci skip]
2017-05-11 22:48:21 -07:00
David Lord 0420cb21db Merge pull request #1965 from vioan/master
Added a missing module to import statement
2017-05-11 22:38:36 -07:00
David Lord 011a4b1899
clean up error handler docs 2017-04-30 08:20:13 -07:00
Benjamin Liebald 6032c94aeb
Mention existence of register_error_handler in errorpages.rst
See https://github.com/pallets/flask/issues/1837 for context.
2017-04-30 07:55:54 -07:00
ka7 e13eaeeaf2 Fix typo in docs (#2237) 2017-04-11 21:44:32 +02:00
Adam Geitgey ae1ac2053b Correct imports in file upload example (#2230)
The example code uses `flash` but doesn't import it. So the code as written doesn't work.

This simply adds `flash` to the list of imports in the sample code.
2017-04-04 22:26:40 +02:00
Ben 7a5e8ef38e Fix broken link (#2202) 2017-03-08 20:26:38 +01:00
Static f5adb61b28 Fix typos/grammar in docs (#2201) 2017-03-06 14:05:59 +01:00
Sebastian Kalinowski fca5577a00 Remove extra HTML tag from fileupload docs (#2141) 2017-02-28 14:05:09 +09:00
Jeff Widman bb0e755c80 Migrate various docs links to https (#2180)
Also fixed a few outdated links
2017-02-11 10:43:11 +01:00
wgwz 1b7258f816 Provides a link to the examples src
- moved the link towards the top for better visibility
2016-12-31 18:51:00 -05:00
wgwz 949771adf5 Add reference to largerapp src in docs 2016-12-30 13:42:14 -05:00
Gábor Lipták 079d752cec Update Flask-SQLAlchemy link (#2126) 2016-12-28 16:11:33 +01:00
Sven-Hendrik Haase ccb562854e Remove wrong comma (#2116) 2016-12-19 05:37:34 -08:00
Shandy Brown 9685d14eaa Correct grammar (#2061) 2016-11-01 18:52:54 -07:00
Geoffrey Bauduin 2b03eca1b7 Updated Celery pattern
The given pattern caused Celery to lose the current Context
2016-10-11 15:27:48 +02:00
Markus Unterwaditzer 12008c2e63 Merge branch '0.11-maintenance' 2016-09-11 17:55:33 +02:00
Kyle Lawlor 59104db2f2 Address #1980 (#2021)
* Distinguish between directories and files

* Convert larger apps to make use of setup.py

- replaces runserver.py with setup.py
- example now runs with recommended structure

* Fixes a typo and formats the added paragraph
2016-09-11 17:53:35 +02:00
sanderl-mediamonks 3313b8b0a4 Use the correct Celery result backend setting 2016-08-22 11:49:52 +02:00
Ioan Vancea 55f9af72e3 Added a missing module to import statement 2016-07-28 16:34:48 +02:00
Shakib Hossain fe53da45c5 Update allowed_file function in fileuploads.rst
Update allowed_file function to accept lowercase and uppercase file extensions
2016-07-16 21:59:44 +06:00
David Lord 1928f28a68 clean up code formatting in some docs
fix warnings while building docs
2016-06-26 13:03:29 -07:00
David Lord cd1a9b7d54 remove unnecessary form action attributes 2016-06-22 15:01:41 -07:00
David Lord d8c39f4b37 Revert "wtforms: Add missing closing tags in example (#1917)"
This reverts commit 146cba53e7.
2016-06-22 14:53:27 -07:00
Baptiste Fontaine 146cba53e7 wtforms: Add missing closing tags in example (#1917) 2016-06-19 13:27:23 -07:00
dcfix 9f2b3d815e Demonstrate how to add multiple urls to the same function endpoint #981 (#1900)
* Demonstrate how to add multiple urls to the same function endpoint

* Removed text as per untitaker, fixed spacing to be pep-8 compliant
2016-06-16 22:40:23 +02:00
Leo Tindall c0087204e5 Documentation: Clarify instructions about changing row_factory for SQLite3 (#1573)
* Clarify instructions about changing row_factory

When I was working through the tutorial, this was very confusing to me; so, I've added the code and clarification that would have helped me get through it faster.

* Clarify the nature of Row objects

* Rewrite code example for further clarity.
2016-06-14 23:55:47 -07:00
David Lord 169a4e0c44 move note about next param, add example, other cleanup 2016-06-05 14:21:17 -07:00
Ping Hu 434c19933e Add clarification for login_required decorator ref #313 2016-06-05 13:22:19 -07:00
David Lord aa9a994946 use pip instead of setup.py in fabric command 2016-06-05 13:12:25 -07:00
David Lord 14a5a9e554 move setup.cfg info to setuptools docs, reword 2016-06-05 12:59:04 -07:00
Shawn McElroy 33212309a2 updating docs and showing how to use `setup.cfg` to configure dev builds with sdist 2016-06-05 12:50:44 -07:00
Markus Unterwaditzer ae97ca8553 Merge pull request #1868 from antsar/master
Rewrite subclassing example with a better use-case.
2016-06-03 14:55:33 +02:00
Anton Sarukhanov 447f591d2b Rewrite subclassing example with a better use-case. 2016-06-02 15:34:56 -07:00
Jeff Widman a228a3b2cf Merge pull request #1862 from antsar/master
Add subclassing pattern/example
2016-06-02 14:32:24 -07:00
Anton Sarukhanov 63b5dab0fc Add subclassing pattern/example to fix issue #221. 2016-06-02 14:17:42 -07:00
Prachi Shirish Khadke d9a98dd536 Document flash message size limit
Reason: Messages of size 68,493 - 91,326 characters cause flash to fail silently.
Session cookies cannot have such large messages.

Issue: pallets/flask#1789
2016-06-02 11:59:04 -07:00
Adam Chainz 70de011d51 Convert readthedocs link for their .org -> .io migration for hosted projects (#1827)
As per their email ‘Changes to project subdomains’:

> Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.

Test Plan: Manually visited all the links I’ve modified.
2016-05-29 15:49:38 +02:00
Armin Ronacher a7d829c618 Update docs to the new CLI patterns 2016-05-26 20:45:50 +02:00
Corey Goldberg 28b36f642d removed references to easy_install 2016-05-04 21:14:25 -04:00
Corey Goldberg 1cc9ccfc67 update docs and refer to setuptools 2016-05-03 11:55:36 -04:00
Daniel Quinn be2abd2926 Fix typo (thing --> things) 2016-04-11 14:57:04 +02:00
José Carlos García 567fff9d0d Change to Pallets project
* Update CHANGES

* Update CONTRIBUTING.rst

* Update setup.py

* Update tox.ini

* Update extensions.rst

* Update security.rst

* Update installation.rst

* Update testing.rst

* Update upgrading.rst

* Update sidebarintro.html

* Update jquery.rst

* Update dbcon.rst

* Update index.rst
2016-04-03 23:11:38 +02:00
bagratte 9a80fe691d minor revision of documentation. 2016-04-01 23:12:25 +02:00
Gaëtan Petit 67e2127a5d Update deprecated references
validators.Required() is marked as deprecated in favor of validators.DataRequired() and will be remove in WTForms 3.
2016-03-08 10:05:20 +01:00
Eric Dill 52daeffdc9 DOC: Remove gendered language 2016-02-09 14:24:09 -05:00
Kenneth Reitz e7367c9bbf Merge pull request #1588 from Akasurde/i_1465
Updated documentation for Setuptools
2016-01-26 20:40:26 -05:00
Dougal Matthews 25aab43f8e Fixed a typo
I think 'app' is the intended word here, but I am not 100% sure.
2015-12-03 09:51:24 +00:00
lord63 51b62fb044 Render the code block in mongokit.rst 2015-11-22 14:43:25 +08:00
Abhijeet Kasurde b51e368cc7 Merge branch 'master' of https://github.com/mitsuhiko/flask
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2015-11-01 09:34:11 +05:30
Abhijeet Kasurde 15f267e1ee Updated documentation for Setuptools
Updated documentation by removing references of distribute and adding
references of setuptools.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2015-10-20 14:40:55 +05:30
msiyaj 808bf6d204 Missing apostophe. 2015-08-27 00:27:44 -04:00
Zev Averbach 5dfe918e4f fixed some punctuation, fixed a few errors, in service of readability 2015-06-26 08:41:56 -04:00