Commit Graph

376 Commits

Author SHA1 Message Date
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
Markus Unterwaditzer b471df6c88 Point to stable version of Celery 2015-06-08 15:18:34 +02:00
Markus Unterwaditzer 7a999cd4b8 Merge branch 'AndrewBMartin-patch-1' 2015-06-06 03:35:22 +02:00
Andrew 337a9d6172 Include backend argument when instantiating Celery
Not including the backend argument can lead to AttributeError:
DisabledBackend object has no attribute for '_get_task_meta_for'.

See e.g.
http://stackoverflow.com/questions/23215311/celery-with-rabbitmq-attributeerror-disabledbackend-object-has-no-attribute.

At the same time, including the backend argument doesn't seem to harm anything else.
2015-06-06 03:35:04 +02:00
Alex Chan 8570633214 Fix a few spelling mistakes in the docs 2015-04-03 20:43:40 +01:00
Torstein Krause Johansen 557a053e3b Moved noted about HTTP 500 before the code examples
- as suggested by @keyan
2015-03-31 19:16:33 +02:00
Torstein Krause Johansen 5dd9335aac Added note that @errorhandler(500) isn't triggered in debug mode 2015-03-31 17:35:29 +02:00
Caleb Bron c0593efbb2 link to sqlalchemy declarative has changed 2015-03-12 10:26:06 -07:00
Markus Unterwaditzer c282ab1ce2 Merge pull request #1354 from idrisr/master
improve grammar, make format consistent, and improve readability
2015-03-05 21:55:08 +01:00
Markus Unterwaditzer 0a492a09a8 Restructure Upload Progress Bars
- Removed dropzone.js, it hasn't been around long enough, maybe we need
  to update this in two years again.
- jQuery should be a proper rst link.
2015-03-04 18:43:59 +01:00
Markus Unterwaditzer 9a61e7d571 Merge remote-tracking branch 'sourya/master' 2015-03-04 18:40:35 +01:00
Idris Raja 81e8bbbb7f improve grammar, make format consistent, and improve readability 2015-02-19 09:57:56 -06:00
Brett Gerry 6517a1a37c deprecate TextField in favor of StringField 2015-01-13 14:47:41 -08:00
Sourya Vatsyayan a6ea6335a5 Updated file uploads progress bar section 2015-01-04 13:00:51 +05:30
Sourya Vatsyayan 50fef79b20 URL generation rule explained for file uploads 2015-01-03 23:32:51 +05:30
Sourya Vatsyayan d2a380451b URL generation rule explained 2015-01-03 20:30:30 +05:30
Markus Unterwaditzer b7dfa6c363 Merge pull request #1280 from jcomo/mongokit-doc-update
Update mongokit pattern
2014-12-17 13:28:24 +01:00
Jonathan Como bd4921194e verbage 2014-12-16 23:52:43 -08:00
Jonathan Como a8498b6859 update mongokit patterng 2014-12-15 13:25:15 -08:00
Kevin Yap 475d7076f0 Standardized capitalization of "GitHub" in docs 2014-12-12 22:55:12 -08:00
Mieszko 091852ef88 Minor typos cont. 2014-11-12 13:34:01 +01:00
Mieszko 5d9cdc65b5 Update sqlite3.rst 2014-11-08 22:21:27 +01:00
Mieszko 9db775e2dd Minor typos fixed
According to Cambrigde English Dictionary "web server" ==correct, "webserver" ==incorrect.
2014-11-06 23:42:44 +01:00
defuz 5562acfdfc docs: fix warnings 2014-11-05 08:04:06 +03:00
defuz d6f5eb8def docs: `script` -> ``script`` 2014-11-05 07:56:03 +03:00
defuz d338dc8a13 docs: ``.html``, ``.py`` 2014-11-05 07:52:04 +03:00
defuz d4b9b9854c docs: :mimetype:`application/json` 2014-11-05 07:43:00 +03:00
defuz 663802e976 docs: ``with``, ``for``, ``self`` 2014-11-05 07:39:54 +03:00
defuz 0bb4de1e3b docs: ``<body>``, ``|safe`` 2014-11-05 07:27:25 +03:00
defuz 17eee81da0 docs: ``Flask-Uploads``, ``X-Forwarded-Host`` 2014-11-05 07:23:47 +03:00
defuz 06d9a5e738 docs: :file:`/var/www/foo`, ``/static`` 2014-11-05 07:19:02 +03:00
defuz ad011bc32d docs: ``DEBUG``, ``SERVER_NAME``, ``PATH_INFO`` 2014-11-05 07:10:49 +03:00
defuz 02694d609f docs: :command:`pip`, :option:`--debug` 2014-11-05 07:03:55 +03:00
defuz a8f570cc62 docs: :file:`app.py`, :file:`yourapp/templates` 2014-11-05 06:45:22 +03:00
defuz 3fa4fd0908 docs: http method names like ``GET`` and ``POST`` 2014-11-05 06:13:01 +03:00
defuz 8284217593 docs: ``True``, ``False`` and ``None`` 2014-11-05 06:04:58 +03:00
flowerhack bcba7eb397 Tweaked sqlite3 documentation 2014-11-03 12:11:02 -05:00
Petr Zemek 3159c86166 Unify the uses of "sourcecode" vs "source code".
Use "source code", which is more grammatically correct.
2014-10-27 11:54:28 +01:00
Petr Zemek ebab6718f7 Unify the uses of "testsuite" vs "test suite".
Use "test suite", which is more prevailing in the source code.
2014-10-27 11:31:01 +01:00
Markus Unterwaditzer a18dedc5d3 Merge pull request #1191 from nluchs/patch-2
Minor typo in errorpages.rst
2014-09-28 07:11:39 +02:00
Nick Luchsinger 37fb0516f4 Minor typos in sqlite3.rst
Self-explanatory.
2014-09-27 18:39:43 -07:00
Nick Luchsinger 55db14ec68 Minor typo in errorpages.rst 2014-09-27 15:34:08 -07:00
Nico Revin 22219f51e5 Update doclinks
Fix redirects and broken links
2014-07-24 23:30:50 +04:00
Kenneth Reitz 76456dc3b2 Merge pull request #1075 from brannerchinese/master
add `Table` to import in `sqlalchemy.rst` example
2014-05-30 13:39:21 -04:00
David Branner fb5d674488 add `Table` to import in `sqlalchemy.rst` example 2014-05-30 12:48:49 -04:00
Wing 02b02543b3 Doc for add check upload file 2014-05-17 14:44:34 +08:00
Kenneth Reitz 8fd1825551 Merge pull request #1010 from plumdog/master
Tweaks to docs/patterns/viewdecorators.rst
2014-05-09 15:48:36 +02:00
Armin Ronacher a3ad5405a6 Updated documentation once more for new cli. 2014-04-29 01:03:32 +02:00
Daniel Neuhäuser e89c867d62 Switch packages.python.org to pythonhosted.org 2014-04-26 01:35:37 +02:00
Daniel Neuhäuser 34871a286e Switch pypi links to https
To which the http version redirects permanently
2014-04-26 01:30:28 +02:00
Armin Ronacher 8a46eec4f8 Fixed a reference in the docs. 2014-04-21 17:51:52 +02:00
Andrew Plummer b2b531a36b Tweak wording in viewdecorators.rst 2014-03-26 16:52:06 +00:00
Andrew Plummer db1be12aea Fix import in viewdecorators.rst for @templated 2014-03-26 16:40:25 +00:00
Kenneth Reitz 7e4d51c91c Merge pull request #869 from christophersu/doc-fix-1
Add missing import on SQLAlchemy documentation page
2014-03-21 16:46:05 -04:00
Armin Ronacher 82f99f42a8 Disarmed a sentence a bit 2014-02-09 13:35:38 +00:00
Armin Ronacher 47a41b645f Merge pull request #884 from rsyring/patch-2
Update appfactories.rst, make extension related section clearer
2014-02-09 13:27:35 +00:00
Armin Ronacher 6f44ca705f Fixed sqlite3 pattern. This fixes #924 2014-02-08 22:14:23 +00:00
Armin Ronacher e95cef66a3 Merge pull request #931 from aphexcx/patch-1
Update celery.rst
2014-02-08 17:47:22 +00:00
Armin Ronacher 1f638d63ff Merge pull request #948 from Spittie/patch-1
Update fileuploads.rst
2014-02-08 17:34:30 +00:00
Alex Pearce 3d6de4dd79 Explicitly pass the Celery instance name.
When starting a Celery worker module, it is assumed that the Celery instance within the module is called `app`. This is not the case in the Celery pattern, where it is called `celery`, and so must be explicitly referenced.
2014-02-05 20:11:06 +00:00
Spittie de3dbd3125 Update fileuploads.rst
secure_filename is under werkzeug.utils (http://werkzeug.pocoo.org/docs/utils/)
2014-01-12 02:54:08 +01:00
Afik 67c165bcbb Update celery.rst
With the latest version of Celery (3.1.6), following this tutorial produces the following error when attempting to start the celery worker: 

    user_preload = tuple(self.app.user_options['preload'] or ())
AttributeError: 'Flask' object has no attribute 'user_options'

Using `app` as the variable name here confuses celery. Renaming `app` to `flask_app` in the tutorial solves the issue and allows the celery worker to start successfully.
2013-12-16 22:04:51 -08:00
Christopher Su 9cecf0d81c moved Table import to next code block 2013-10-22 11:37:35 -07:00
Sean Cronin a7f5d60789 Makes the error names consistent 2013-10-15 12:37:25 -04:00
rsyring fc85bf42ae Update appfactories.rst, make extension related section clearer 2013-10-11 08:39:46 -04:00
Christopher Su 8089eb5769 added missing import in sqlalchemy doc 2013-09-19 23:31:09 -07:00
Jet Sun 6ebe45b0ad Fix typo. 2013-09-07 17:42:06 -07:00
Bill Mill 159ae3dc26 Fix doc bug, clarify use of make_dicts 2013-07-31 22:06:15 -04:00
Armin Ronacher 335cbe01ce Fixed a typo 2013-06-11 20:18:26 +01:00
Armin Ronacher f9f8180f15 Added documentation on API error handlers 2013-06-09 17:26:10 +01:00
Armin Ronacher 29bda590b2 Modernized docs in a few places 2013-06-09 12:30:27 +01:00
Armin Ronacher 681cb8f366 Switch to teardown_appcontext for docs in sqlalchemy pattern 2013-06-07 15:42:49 +01:00
Armin Ronacher ef72b78042 Imply the |safe on tojson in templates and change escaping logic 2013-06-03 12:25:08 +01:00
Thomas Waldmann 8bb972e5ae fix minitwit/flaskr test errors, improve docs about file open mode
app.open_resource needs to get called with the correct mode param (python3
will read bytes [not str] if the wrong mode is used), add mode param docs.

rv.data is bytes, fix the data type we compare it with to be also bytes
2013-05-25 19:13:48 +02:00
Thomas Waldmann 40fad2ece8 document python 2.6 minimum requirement, remove all stuff that refers to 2.5 2013-05-18 17:06:25 +02:00
Armin Ronacher ef62e8440e Merge pull request #702 from edburnett/master
AJAX with jQuery documentation update
2013-05-14 03:25:49 -07:00
Jason Moon d1bf82b0f4 Fixed typo in URL Processor documentation 2013-04-14 00:10:38 -07:00
Ed Burnett 0a5d62f9ee Updated jquery.rst with the current Google Developer hosted libraries URL and jquery version 2013-03-26 16:56:05 -07:00
Markus Unterwaditzer 9d8674d5b6 Added more information about app factories. 2013-03-17 21:42:30 +01:00
Alex Couper a92588f161 Add closing html tag 2013-02-22 11:15:40 +00:00
Armin Ronacher 05f162329d Added celery pattern 2013-01-27 00:38:25 +00:00
Kenneth Reitz 3fdcefbcda Merge pull request #625 from soulseekah/master
Use sqlite3.Row factory in Flaskr (#588)
2013-01-24 20:22:02 -08:00
Trung Ly b4fc4412e8 Update docs/patterns/deferredcallbacks.rst
fix example code in Deferred Callback docs: don't set response upon executing callback
2013-01-14 14:53:06 -08:00
Erik Rose a319516518 Fix a typo in the deferred-callbacks docs. 2012-12-11 14:11:27 -08:00
Max Countryman caefb67ccd correcting typo 2012-11-05 15:31:07 -08:00
Gennady Kovshenin 82b29c09ac Use sqlite3.Row factory in Flaskr
As pointed out in issue #588 sqlite3.Row should be used instead of
using casting to dict(). Also altered the "Easy Querying" Patterns
example to include the more correct way to return rows as dicts.
Did not touch Tutorial examples ("Views"), as these are not up to
date with the current Flaskr code, and the "Show Entries" section
points out the "Easy Querying" section on how to convert to a
dict().
2012-11-05 06:00:46 +06:00
Armin Ronacher c2e5799879 Updated examples to new sqlite patterns and added new section to appcontext docs 2012-10-09 14:02:32 -05:00
Armin Ronacher b5bb49d080 Added a new example for checksums on input data. This fixes #601 2012-10-07 15:46:21 +02:00
Armin Ronacher 18413ed1bf Added HTTP override middleware to docs. This fixes #582 2012-10-07 13:02:05 +02:00
pinchsp 69e419e020 Fixed small mistake in sqlalchemy pattern 2012-09-04 00:51:45 -03:00
Armin Ronacher d5218997d9 Added flask.stream_with_context 2012-06-27 15:06:39 +01:00
Armin Ronacher 9be47f5932 Merge pull request #479 from dmishe/patch-1
Removed unneeded print statements form mongokit pattern doc
2012-06-17 06:25:10 -07:00
Ron DuPlain a3cb2a3382 Use American English for "behavior" in docs.
Prompted by plaes on #pocoo, mitsuhiko confirmed to use American English.
2012-04-19 11:51:38 -04:00
Ron DuPlain b885edf810 Fix typo pointed out by tri on #pocoo. 2012-04-18 15:54:04 -04:00
Dmitry Shevchenko 9c48387072 Removed unneeded print statements form mongokit pattern doc 2012-04-08 18:09:12 -05:00
Ron DuPlain df772df24f Touch up run_simple doc, #446. 2012-04-01 11:40:37 -04:00
Ron DuPlain 8740fff907 Merge pull request #446 from jtsoi/patch-1
Debug example with run_simple and flask app.
2012-04-01 08:37:44 -07:00
Kenneth Reitz 079c5ef7ff Merge pull request #445 from iammookli/patch-1
Update docs/patterns/mongokit.rst
2012-03-20 19:01:28 -07:00
Filip Ristić c2661dd4bc Update docs/patterns/packages.rst 2012-03-20 22:07:58 +01:00