Commit Graph

1327 Commits

Author SHA1 Message Date
Lowell Abbott 09a0d2ebd1 Re-order by semantic. Fix link on flask-talismand and re-word many concepts 2017-05-23 12:26:43 -07:00
David Lord cd593bf117 Merge pull request #2307 from neilvictorgrey/master
For Issue #2286: Update unittest references
2017-05-23 11:50:31 -07:00
David Lord 8858135043 Update testing.rst 2017-05-23 11:50:14 -07:00
Levi Roth 954d9ca0b8 Added documentation for PowerShell environment variables 2017-05-23 14:30:39 -04:00
Lowell Abbott ee7cb9d6b2 Suggest only one package, change the sourcecode block to none 2017-05-23 01:54:06 -07:00
Lowell Abbott c47f4530a1 Erased duplicated links on title 2017-05-22 23:54:28 -07:00
Lowell Abbott 98b0f96a98 Fix typos, semantics and some other corrections 2017-05-22 23:48:35 -07:00
Lowell Abbott 8459cedaa9 Add security headers notes 2017-05-22 20:52:02 -07:00
Neil Grey 378a11f992 For Issue #2286: Updating test_flaskr to use yield inside fixture 2017-05-22 18:22:08 -07:00
Tully Rankin 65b61aa7c2 Added uWSGI and example usage to stand-alone WSGI containers documentation (#2302) 2017-05-22 18:08:40 -07:00
Neil Grey 4e9d51b39b For Issue #2286: Fixing indenting of test_login_logout 2017-05-22 17:42:30 -07:00
Neil Grey 65fc888172 For Issue #2286: Replaces references to unittest in the documentation with pytest 2017-05-22 17:36:55 -07:00
Tully Rankin 2b96052240 Moved mod_wsgi under uwsgi in TOC deployment docs. 2017-05-22 15:13:31 -07:00
Tully Rankin d7d21f5559 Moved WSGI-Standalone above mod_wsgi in deployment documentation. 2017-05-22 14:48:24 -07:00
Tully Rankin 50b73f967b Removed the version number out of the documenation link to Werkzeug. 2017-05-22 12:19:52 -07:00
Tully Rankin 409dd15c10 Added link to using Werkzeug debugger in quickstart documentation. 2017-05-22 12:14:52 -07:00
Tully Rankin 041c68f48b Updated request context documentation. 2017-05-22 11:28:58 -07:00
Tully Rankin c590e820aa Updated documentation. Replaced term development mode with debug mode. #2261 2017-05-22 11:25:02 -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 c01ddc59b7 Merge pull request #2277 from jlara310/master
Improve quickstart's Routing section
2017-05-11 22:32:00 -07:00
David Lord 2592f927a0
wrap lines
tighten up wording
remove any converter from quickstart
use correct rst code syntax
2017-05-11 22:31:19 -07:00
David Lord 1fb43e3be4
rewrite installation docs
discuss python version
discuss all dependencies
prefer python 3 in instructions
[ci skip]
2017-05-11 14:34:09 -07:00
Xephyr826 dfb03c5673 Improve Routing section
Edited the entire section for clarity and concision. I rewrote sentences
to make them shorter and to reduce ambiguity.

Added a code sample to show the path converter type

Removed the HTTP method overview. Although it was well written, the
overview wasn't necessary in the quickstart. Readers can easily find an
overview elsewhere.
2017-05-10 22:38:22 -07:00
David Lord 5b83f11398 Merge pull request #2213 from runartrollet/doc_virtenv_p3
Issue #2212: documentation: virtualenv and python3
2017-05-09 11:04:23 -07:00
David Lord d2a0b2911b Merge pull request #2210 from Larivact/patch-2
Clarify APPLICATION_ROOT documentation
2017-05-09 08:47:23 -07:00
David Lord 17685da8c0 Merge pull request #1942 from jmsdvl/fix-1935
clarify blueprint 404 error handling in docs
2017-05-09 08:44:58 -07:00
David Lord 75b85656dd
optionally enable sphinxcontrib.log_cabinet
collapses old changelog directives
closes #1704
closes #1867
2017-05-04 18:24:04 -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
David Lord f22da31e7f Merge pull request #2191 from SergioDS/master
Updated documentation for being able to use init_db method
2017-04-21 11:45:16 -07:00
David Lord cfd3e50ab6
use app.testing property instead of config 2017-04-14 05:26:29 -07:00
David Lord 03857cc48a
use app.testing property instead of config 2017-04-13 16:32:44 -07:00
accraze 1caa9de628
Added missing testing config
fixes #1302
2017-04-13 16:27:58 -07:00
ka7 e13eaeeaf2 Fix typo in docs (#2237) 2017-04-11 21:44:32 +02:00
Grey Li ec18fe9477 Add example for virtualenv integration in cli docs (#2234) 2017-04-07 07:10:43 -07: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
Runar Trollet Kristoffersen 889c0ed196 Issue #2212: documentation: virtualenv and python3 2017-03-19 18:01:23 +01:00
Larivact 2995366dde Clarify APPLICATION_ROOT #1714 2017-03-17 05:41:20 +01:00
Jan Ferko 1add1f8a02 Use print function in quickstart (#2204)
Example in URL Building section uses `print` statement
instead of `print` function, which causes syntax error
when example is run on Python 3.
2017-03-13 13:58:24 +01:00
Ben 7a5e8ef38e Fix broken link (#2202) 2017-03-08 20:26:38 +01:00
Hsiaoming Yang a7f1a21c12 Don't rely on X-Requested-With for pretty print json response (#2193)
* Don't rely on X-Requested-With for pretty print json response

* Fix test cases for pretty print json patch

* Fix gramma error in docs for pretty print json config

* Add changelog for JSONIFY_PRETTYPRINT_REGULAR
2017-03-07 10:09:46 +09:00
Static f5adb61b28 Fix typos/grammar in docs (#2201) 2017-03-06 14:05:59 +01:00
Elton Law 06112a555a Close <li> tag in tutorial (#2199)
Change was merged in the example code but wasn't changed in the docs. c54d67adee
2017-03-05 13:07:49 +01:00
Grey Li c43560777a Add tips for debug config with flask cli (#2196)
* Add tips for debug config with flask cli

`app.debug` and `app.config['DEBUG']` are not compatible with the `flask` script.

* Grammar fix

* Grammar fix
2017-03-04 11:29:04 +01:00
Sebastian Kalinowski fca5577a00 Remove extra HTML tag from fileupload docs (#2141) 2017-02-28 14:05:09 +09:00
Sergio Díaz Sánchez af11098057 Updated documentation for being able to use init_db method 2017-02-28 00:13:45 +01:00
Timothy John Perisho Eccleston dc5f48f587 Fix typo in docs/tutorial/templates.rst (#2186) 2017-02-18 07:41:58 +01: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
vojtekb 95db82f8f7 py.test => pytest (#2173)
py.test => pytest
2017-02-09 18:34:16 +01:00
Swan Htet Aung f84fdadda9 Update 4.4.3 HTTP Methods Example
Otherwise it produces `ValueError: View function did not return a response`.
2017-02-09 18:01:12 +06:30
Jeff Widman fe7910ccd5 Update docs that request is an object, not a class (#2154)
Cleanup sphinx formatting to show that `request` is an object, not a class. The actual class name is `Request`.

Based on discussion [here](https://github.com/pallets/flask/pull/2151#issuecomment-272699147).
2017-01-17 20:20:07 +01:00
Markus Unterwaditzer 47e8410117 Merge pull request #2131 from wgwz/add-larger-app-ex
Add larger app ex
2017-01-15 05:56:12 +01:00
Dennis Chen 9900a72fe7 Fix Request Reference (#2151)
Points flask.Request to appropriate place in the documentation.
2017-01-14 21:58:45 +01:00
Ondřej Nový 9dcfd05d29 Use SOURCE_DATE_EPOCH for copyright year to make build reproducible
Details: https://wiki.debian.org/ReproducibleBuilds/TimestampsProposal
2017-01-13 10:54:55 +01:00
Adrian Moennich 88111ae6bf Do not suggest deprecated flask.ext.* 2017-01-10 13:12:18 +01:00
Bryce Guinta 09973a7387 Fix fastcgi lighttpd example documentation. (#2138)
Add a trailing slash to the dummy path in the fastcgi lighttpd setup
documentation. Omitting a trailing slash leads to unintended behavior.
2017-01-01 18:51:21 -08: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
Markus Unterwaditzer 49386ee69e Inherit Werkzeug docs (#2135)
Fix #2132
2016-12-31 16:31:44 +01: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 0ba1a872b7 Style the flask command consistently (#2120)
It's done like this in other parts of this doc.
2016-12-21 21:06:48 +01:00
Sven-Hendrik Haase ccb562854e Remove wrong comma (#2116) 2016-12-19 05:37:34 -08:00
ezramorris 4a8bf651d9 Add link to AWS EB Flask tutorial 2016-11-17 14:01:30 +00:00
Jannis Leidel 4cf4229355 Fix rST rendering of env var (#2085)
This was broken in ad011bc32d (diff-fd40cf2be7711772de9d8316da038cceR263)
2016-11-15 11:57:09 +01:00
Giles Thomas 281c9c3ff9 Added a link to instructions for PythonAnywhere (#2081) 2016-11-07 10:10:02 -08:00
David Lord 08d6de73a8
switch to packaged sphinx theme 2016-11-03 23:01:10 -07:00
Tery Lim ec9717502f Update errorhandling.rst (#2075)
Fix LogRecord class reference.
2016-11-01 21:04:20 -07:00
Tery Lim bbe58a4944 Update errorhandling.rst (#2074) 2016-11-01 19:58:22 -07:00
Shandy Brown 9685d14eaa Correct grammar (#2061) 2016-11-01 18:52:54 -07:00
Markus Unterwaditzer 2b8fef4fe7 Merge branch '0.11-maintenance' 2016-10-30 14:35:15 +01:00
Kyle Lawlor fa087c8929 Fixes import statement in flaskr (#2068)
- `from flaskr.flaskr import app` in flaskr/__init__.py
  causes an import error with Python 2
- The relative import now used works for py2 and py3
2016-10-30 14:34:49 +01:00
Ionuț Ciocîrlan 2cc76628d2 Fix grammar in docs 2016-10-24 13:20:54 +02:00
David Lord cdbd63d7de Windows venv is Scripts, capital S
closes #2056
2016-10-12 12:14:49 -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
Michael Recachinas 49ecc88d99 Remove `-a/--app` from Quickstart documentation (#2046)
* Remove `-a/--app` from Quickstart documentation

As mentioned in #2009, simplifying the CLI saw the removal of the `-a/--app` flag. Therefore, the only way to specify the module to import is by setting `FLASK_APP`.

* Remove misleading `either` from CLI help

The CLI help details how to run the application, but still uses the phrasing "either through the `FLASK_APP`...". This likely is an artifact from when `-a/--app` was still present in the CLI.
2016-10-01 18:45:22 +02:00
Douglas Thor a6a36ec72a Updated mod_wsgi.rst to point to new mod_wsgi repo (#2038) 2016-09-24 13:07:19 +02:00
Markus Unterwaditzer dcfdfc6476 Use abort docs from Werkzeug
Fix #1960
2016-09-18 15:47:52 +02:00
Andrew Arendt 270355abdc Remove nonsense from cli docs 2016-09-14 20:03:21 +02:00
Armin Ronacher a40489e0ce Merge pull request #2019 from pallets/bugfix/sendfile-error
Do not cause errors for unknown files for sendfile
2016-09-12 21:52:42 +03:00
Armin Ronacher 11f3a3f6dd Updated upgrade docs 2016-09-11 21:28:30 +03: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
Markus Unterwaditzer 7132feb1a5 Merge branch '0.11-maintenance' 2016-09-08 15:21:05 +02:00
Kyle Lawlor e6f9d2b414 Clean up tutorial docs for installable app pattern with flaskr (#2002)
* Clean up tutorial docs for installable app pattern

- reading sequentially through the tutorial works.
- fixes references to `export FLASK_APP=flaskr.flaskr`

* Fixes titles for each section of flaskr tutorial

* Revert grammar

* Emphasize the Packaging Guide

- adds more general packaging resource
- removes the emphasis put on setuptools

* rephrase and remove note admonitions

- expanded on few points
- removed note blocks, they are unneccessary

* Remove note about reinstalling to update cli

- I had mistakenly thought it was necessary to
  re-install the app to update the cli.
- the `--editable` flag detects the change and
  the cli updates without issue.
2016-09-08 15:19:48 +02:00
PHeanEX 96b6345c1a Fix small grammar error (Of/Or) (#2001) 2016-08-31 13:05:12 -07:00
Josh Soref 6e6c3a4636 Spelling (#1998)
* spelling: cacheability

* spelling: conceptually

* spelling: javascript

* spelling: reset

* spelling: raised

* comma: instead..., they...
2016-08-30 00:26:20 +02:00
dawran6 3d856e03fc sessions documentation (client side vs server side) #434 (#1888)
Mention the existence of Flask extentions that handle server-side
sessions.
Attempt to improve the reading flow.
2016-08-29 00:06:53 +02:00
Markus Unterwaditzer 71e10be286 Properly remove f.name usage in send_file (#1988)
* Properly remove f.name usage in send_file

* Update changelogs

* Fix tests
2016-08-26 03:08:03 +02:00
sanderl-mediamonks 3313b8b0a4 Use the correct Celery result backend setting 2016-08-22 11:49:52 +02:00
Zev Averbach 863e5cca1b added indentation to changed structure 2016-08-20 17:13:07 -04:00
SaturnR 55bd39c7f0 Update for python3 (#1973)
just updated print 'Initialized the database.' with print('Initialized the database.') to be python3 compliant
2016-08-20 17:43:10 +02:00
teichopsia- 5044f3d610 Update testing.rst (#1987)
Python 3.4.2
TypeError: Type str doesn't support the buffer API
2016-08-19 19:01:13 -07:00
Adam Byrtek 5ebdd5dd74 Documentation updates 2016-08-19 21:21:43 +02:00
Adam Byrtek 5575faad92 Update documentation to use the getter only once 2016-08-19 21:20:59 +02:00
Adam Byrtek f0d3b71a94 Updates after code review 2016-08-19 21:19:33 +02:00
Adam Byrtek 539569e5f2 Update the testing documentation 2016-08-19 21:19:17 +02:00
Adam Byrtek 23de58682c Remove redundant `cache` flag 2016-08-19 21:19:17 +02:00
Auke Willem Oosterhoff e6d7a43ccd Use path of socket consistently accross document. (#1976)
* #1975 Use location of socket consistently accross document.
2016-08-03 09:22:14 -07: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 633b13e9b5 Merge branch '0.11-maintenance' 2016-07-05 17:34:51 -07:00
Kyle Lawlor 17d4cb3828 Address #1902: Converts example/flaskr to have a setup.py (#1945)
* Converts example/flaskr to have a setup.py

Makes the flaskr app easier to run, ex. workflow:
- pip install --editable .
- export FLASK_APP=flaskr.flaskr
- flask initdb
- flask run

Testing is also easier now:
- python setup.py test

* Fixed an import error in flaskr/tests

- the statement `import flaskr` caused errors in python3
- `from . import flaskr` fixes the issue in 2.7.11 and 3.5.1

* Better project structure and updates the docs

- Re-factors *flaskr*'s project structure a bit
- Updates docs to make sense with the new structure
  - Adds a new step about installing Flask apps with setuptools
  - Switches first-person style writing to second-person (reads better IMO)
  - Adds segments in *testing.rst* for running tests with setuptools

* Remove __init__.py from tests

- py.test recommends not using __init__.py

* Fix testing import errors
2016-07-05 17:30:59 -07:00
Olexander Yermakov b7a0cc61c5 Update installation documentation for using 'pip' command (#1920) 2016-07-05 12:00:43 -07:00
John Still 0c459762ea clarify blueprint 404 error handling in docs 2016-07-02 17:03:36 -05: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
Ameya Pandilwar 663d786f68 Update documentation for upgrading Flask using 'pip' command (#1918) 2016-06-22 13:26:35 -07:00
Sudheer Satyanarayana 1ffd07ff5a Fix small typo in python3 docs
Add missing 'be'
2016-06-21 17:27:03 +02: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
avborhanian 5aa70b5a56 Updating url in errorhandling.rst to a valid link
Was originally set to github.com/getsentry/sentry, which was a relative link to a page that doesn't exist. I prepended https:// to fix this problem.
2016-06-06 11:29:14 -04:00
Markus Unterwaditzer f6b5b571dc Fix several typos in python3.rst
- complicated -> complicates, since the effect continues into the
  future. See #1891

- effect -> affect

- Rewrap paragraph
2016-06-06 13:39:14 +02:00
Ryan Backman 3384813151 Clarify wording in App Context documentation. (#1890) 2016-06-06 13:03:01 +02:00
David Lord baa2689658 clean up py3 info more 2016-06-05 15:45:39 -07:00
alatar- 00c200eeaa Update documentation about python 3 support in Flask, resolves #1578 2016-06-05 15:25:35 -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
RamiC 9c236d3b84 Mention the template name conflict issue in blueprint templates docs (#1843)
* Mention the template name conflict issue in docs.
In the blueprints templates documentation mention
the possible templates name conflict issue
re #266

* Mention priorities between blueprints
and other rephrasing fixes
2016-06-03 23:25:16 -07:00
Zev Averbach 19dcdf4e70 enumerates the states in which code is executed...
... and fixes an awkward phrasing.
2016-06-03 16:59:15 -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
wldtyp fa327fd4fa Tutorial: Note extensions for encrypting passwords (#1854)
Fix #836
2016-06-03 01:00:55 -07:00
Hyunchel Kim 62aaee02f7 Add a link to Extension Development (#1875) 2016-06-03 07:15:00 +02:00
Jason Brazeal d88c08e56f improved documentation for config.from_object (#1870) 2016-06-02 15:40:59 -07: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
Jeff Widman 808d2cf75e Merge pull request #1861 from ryanbackman/master
Document Runtime Error when running outside of application context
2016-06-02 14:15:24 -07:00
Ryan Backman cbdd2aa141 Document Runtime Error when running outside of application context 2016-06-02 14:05:49 -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
Jochen Kupperschmidt 83ae787f97 Fix typo in cli docs 2016-05-31 16:24:11 +02: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
Markus Unterwaditzer f91aea2aa0 quickstart: Remove reference to `python hello.py`
Fix #1826
2016-05-29 15:46:48 +02:00
Armin Ronacher 42b7ab3f49 Incorporated ThiefMaster's suggestions for docs 2016-05-27 00:17:58 +02:00
Armin Ronacher 3e651e795a Added sentry to docs 2016-05-26 22:57:12 +02:00
Armin Ronacher 9594876c1f Added plugin support to the cli 2016-05-26 21:29:01 +02:00
Armin Ronacher f9ea3fe026 1.0 -> 0.11 in the docs 2016-05-26 20:52:17 +02:00
Armin Ronacher 1df426aaaa More doc updates for FLASK_APP 2016-05-26 20:48:49 +02:00
Armin Ronacher a7d829c618 Update docs to the new CLI patterns 2016-05-26 20:45:50 +02:00
ThiefMaster c5900a1adf s/1.0/0.11/ in versionadded/versionchanged markers
closes #1817
2016-05-23 14:43:23 +02:00
Markus Unterwaditzer e8bd2c9202 Merge pull request #1795 from cgoldberg/update-docs-setuptools
update docs and refer to setuptools
2016-05-08 21:58:38 +02:00
Stefan Wójcik e45e17c490 fix a grammar mistake (#1798) 2016-05-05 19:27:45 +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
David Lord 317d60307d fix some warnings while building docs 2016-04-11 16:13:59 -07:00
Daniel Quinn be2abd2926 Fix typo (thing --> things) 2016-04-11 14:57:04 +02:00
Steven Loria 2bf477cfea Add JSONIFY_MIMETYPE configuration variable (#1728)
Allow jsonify responses' mimetype to be configured
2016-04-08 15:30:47 -07:00
Jeff Widman 8c595f1eba Remove dotCloud host instructions
dotCloud is no more; their parent company went bankrupt
2016-04-06 23:30:41 -07:00
Winston Kouch 594d1c5eb2 Add note to not use plain text passwords to views.rst 2016-04-05 18:53:08 +02:00
Keyan Pishdadian 1a877fbaa0 Remove extmigrate from Flask repo
* Remove extmigrate from Flask repo

* Update docs to reflect new repo location
2016-04-04 23:19:10 +02:00
Stéphane Raimbault b0105f41cc Extend documentation about uwsgi/nginx deployment 2016-04-04 08:53:34 +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
Markus Unterwaditzer d3d8a4694a Deprecate flask.ext
* Add deprecation warning to ext pkg

* Add docs on deprecation of flask.ext

* Improve deprecation warnings

* Add headers for better distinction, fix ordering issue of paragraphs
2016-04-02 21:06:30 +02:00
bagratte 9a80fe691d minor revision of documentation. 2016-04-01 23:12:25 +02:00
lord63 e0a8fd3162 Add two missing converters for flask in the docs
All converters are from werkzeug's builtin converters.

Documentation: http://werkzeug.pocoo.org/docs/dev/routing/#builtin-converters
2016-04-01 14:05:11 -07:00
gunbei 55e37d4f09 update get-pip.py location 2016-03-23 11:27:05 +01:00
Austen D'Souza fc0e1a8d8a Fixed typo
I think it's supposed to be an upper-case 'F'. Cheers :)
2016-03-23 02:02:04 +05:30
whiteUnicorn bc9619beba Replace ';' to ','
I think it is awkward. Though semicolon can be used as a kind of supercomma, this sentence is not that kine of thing. Replacing it with comma would be more better. isn't it?
2016-03-15 00:02:29 +09:00
Ethan Rogers adeedddbb5 Fix minor typo in security doc 2016-03-11 10:06:00 -07: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
Markus Unterwaditzer e7d548595e Merge pull request #1456 from jonafato/proxy-setup-x-forwarded-proto
Add X-Forwarded-Proto header to proxy setup example docs
2016-02-17 22:02:22 +01:00
Eric Dill 52daeffdc9 DOC: Remove gendered language 2016-02-09 14:24:09 -05:00
Prayag Verma 6c0496a1f3 Fix a typo
`interchangable` → `interchangeable`
2016-02-08 19:33:34 +05:30
lord63 6d0bbd627c Fix typo
* Use the compatible way to handle the exception. You can find the
source code wsgi_app in app.py, and it use the compatible way, so update it
* Fix typo in config.py
* Fix typo in app.py
2016-02-03 21:08:22 +08:00
Kenneth Reitz e7367c9bbf Merge pull request #1588 from Akasurde/i_1465
Updated documentation for Setuptools
2016-01-26 20:40:26 -05:00
Jeff Widman daceb3e3a0 Add support for serializing top-level arrays to JSON
Fix #170, #248, #510, #673, #1177
2016-01-13 13:20:11 -08:00
accraze fcd573e120 added note about directory permission syntax change
docs had httpd 2.2 syntax for directory permission with a link to Apache 2.4 changes. added an example of httpd 2.4 syntax

resolves #1644
2015-12-09 20:24:23 -08: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
Armin Ronacher 751fe451df Merge pull request #1558 from JonasGroeger/master
Update uwsgi/nginx deployment documentation
2015-11-12 13:08:56 +01:00
Daniel Thul 2faf245876 Fix typo. 2015-11-11 23:46:51 +01:00
wodim 4a8f3eacbb Fix typo in templating.rst 2015-11-04 12:00:44 +01: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
David Lord 41622c8d68 Link article about deploying on Azure/IIS 2015-10-31 15:17:45 -07:00
David Lord 233886dda2 Merge pull request #1565 from msiyaj/master
Missing apostophe.
2015-10-30 19:20:27 -07:00
David Lord 84a12afd4d Merge pull request #1593 from timofurrer/master
support timedelta for SEND_FILE_MAX_AGE_DEFAULT config variable
2015-10-30 11:10:08 -07:00
Michael Klich 99bc0dfd3b Add info about working with VE and Python 3
Python 3 does not have execfile function.
2015-10-29 19:03:20 -07:00
Timo Furrer d526932a09 support timedelta for SEND_FILE_MAX_AGE_DEFAULT config variable 2015-10-24 07:04:23 +02:00
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
Jonas Gröger b644e2747f Mention virtual environments in uwsgi/nginx deployment docs 2015-08-22 01:05:45 +02:00
Jonas Gröger 8b9cb6caa7 Update uwsgi/nginx deployment documentation
Instead of using the uwsgi_modifier1 30 directive, the uwsgi docs
recommend to use the mount / manage-script-name approch which mounts
a module + callable to a certain path. This way, SCRIPT_NAME and
PATH_INFO are correctly rewritten.

See http://uwsgi-docs.readthedocs.org/en/latest/Nginx.html#hosting-multiple-apps-in-the-same-process-aka-managing-script-name-and-path-info

Fixes #1464
2015-08-22 00:56:54 +02:00
Markus Unterwaditzer ac12e362c4 Merge pull request #1520 from zevav/patch-2
fixed some punctuation, fixed a few errors, in service of readability
2015-07-21 13:41:44 +02:00
Wayne Ye 05c2e7c276 Fixed gevent introduction to use libev instead of libevent 2015-07-14 12:36:01 -07:00
Alan Hamlett 99c99c4c16 Enable autoescape for `render_template_string` 2015-07-04 23:41:43 +02:00
Zev Averbach 5dfe918e4f fixed some punctuation, fixed a few errors, in service of readability 2015-06-26 08:41:56 -04:00
ThiefMaster bbaf20de7c Add pop and setdefault to AppCtxGlobals 2015-06-20 18:04:58 +02:00
Alexander Pantyukhin a9066a3756 Changes and docs are modified. 2015-06-17 15:45:37 +02:00
Markus Unterwaditzer beec47a7cc Deduplicate signals docs
Triggered by #1390
2015-06-10 18:42:55 +02:00
Vincent Driessen a4b335a64a Remove the word `trivially` here
A lot of things are trivial, or debatably trivial, but this is not one of them :)
2015-06-10 10:58:49 +02:00
Markus Unterwaditzer b471df6c88 Point to stable version of Celery 2015-06-08 15:18:34 +02:00
Markus Unterwaditzer 66b4ea91b4 Fix #1195 2015-06-06 06:25:41 +02:00
Jeff Widman f80ea4fe5d Some grammar and typo fixes 2015-06-06 04:44:41 +02:00
Daniel Neuhäuser 2b58e6120c Fix wording 2015-06-06 04:44:41 +02:00
Daniel Neuhäuser b9938d0182 Don't allow namespace packages anymore 2015-06-06 04:44:41 +02:00
Daniel Neuhäuser b12d9762e7 Require Python 3.3 and higher for extensions
Flask and several extensions already supports Python 3.3 and higher. By
requiring approved extensions to support Python 3.3 as well we can
quickly achieve better Python 3 adoption and make using Python 3 easier
for users.

The effort of supporting both Python 2.7 and Python 3.3 is small enough
that it shouldn't be a problem to require this from extension authors.
2015-06-06 04:44:41 +02:00
Daniel Neuhäuser 3185f445c9 Drop Python 2.6 minimum requirement for extensions
Python 2.6 is not supported by python-dev anymore and does not get any
security updates. Even though Flask supports 2.6 at the moment, I think
it's not necessary for any extensions that are going to be approved in
the future to support 2.6.
2015-06-06 04:44:41 +02:00
Daniel Neuhäuser 43d6b8a5fc Drop Extension==dev requirement
pip doesn't install links included in the description of projects
anymore. Therefore ==dev install doesn't work anymore.
2015-06-06 04:44:41 +02:00
Jeff Widman f05aeea6dd Correct the order of suggested syntax for extension imports
According to https://github.com/mitsuhiko/flask/issues/1092#issuecomment-47118613 and https://github.com/mitsuhiko/flask/pull/1085#issuecomment-45466907 , the correct order to attempt to import extensions should be flask_foo, then flask.ext.foo, then flaskext_foo.
2015-06-06 04:43:22 +02:00
Markus Unterwaditzer d40288496c Show original autodoc signatures
Alternative to #1403
2015-06-06 04:17:33 +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
Justin Poehnelt 17d7353d39 fixed import of werkzeug secure_filename 2015-05-14 23:44:49 -07:00
Jon Banafato 887d382da1 Add X-Forwarded-Proto to proxy setup example
The ProxyFix middleware provided by Werkzeug uses this header for
returning accurate values from request.is_secure and request.scheme.
Without adding this header, Flask won't properly detect when it is being
served over HTTPS and will fail to generate proper external links and
cause certain extensions (e.g. Flask-OAuthlib) to function improperly.
Adding this header to the example setup should reduce issues encountered
by developers when following this guide.
2015-05-09 12:29:53 -04:00
Ford Hurley d398780852 Mention that custom converters can be defined for url routes 2015-05-01 12:11:55 -04:00
Markus Unterwaditzer 73d89cccec Errorhandlers were NOT *added* in 1.0 2015-04-30 23:05:55 +02:00
Phil Schaf 290372faf1 some details 2015-04-11 18:08:04 +02:00
Phil Schaf 4437eb7ceb slimmed down error handling intro 2015-04-11 18:01:22 +02:00
Phil Schaf d4ad47af62 added info about an exception being raised for the old and broken behavior 2015-04-11 17:44:18 +02:00
Phil Schaf 9d3c4bbb8c Added docs for the error handler rework 2015-04-11 17:25:17 +02:00
Alex Chan 8570633214 Fix a few spelling mistakes in the docs 2015-04-03 20:43:40 +01:00
Markus Unterwaditzer b57a076fa3 Merge pull request #1380 from KWinston/master
Add line of code required to run examples for Other Testing Tricks section
2015-04-02 01:57:06 +02:00
Charles Chan 6c56e4231f Added OpenShift as a free hosting provider alternative 2015-03-31 16:13:29 -07: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
Winston Kouch 6bbbb72843 Add import flask module required to run code on Other Testing Tricks 2015-03-12 23:32:08 -04:00
Caleb Bron c0593efbb2 link to sqlalchemy declarative has changed 2015-03-12 10:26:06 -07:00
Winston Kouch 5f8c850895 Add extensions section to Quickstart documentation 2015-03-11 23:54:09 -04:00
Markus Unterwaditzer 9c1cf1bc08 Fix broken link 2015-03-05 22:04:53 +01:00
Markus Unterwaditzer 7ae1c5a8b9 Merge pull request #1325 from bsutherland/rqst_properteis_doc_iri_patch
Clarify contents of request properties.
2015-03-05 22:03:54 +01: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
Jeff Widman ffe0c54891 Grammer and readability fixes 2015-02-09 01:03:08 -08:00
Bruce Sutherland 0d86a89420 Wrap text. 2015-01-22 09:12:18 +09:00
Bruce Sutherland 871077c81c Show requested URI as suggested by untitaker. 2015-01-21 20:52:42 +09:00
Bruce Sutherland 77141c1eca Update api.rst
Changed Japanese text to pi symbol, emphasize that values are unicode.
2015-01-21 15:00:38 +09:00
Bruce Sutherland 3bbe869dd7 Clarify contents of request properties.
Change URL to IRI and update examples to include extended characters.
2015-01-21 14:09:30 +09:00
Carlos Eduardo Rivera 65465ffece grammar fixes 2015-01-16 03:36:17 -06:00
Brett Gerry 6517a1a37c deprecate TextField in favor of StringField 2015-01-13 14:47:41 -08:00
Jochen Kupperschmidt e3bb34ec24 Added missing import.
As this specific code block lists imports in general and an import from the `flask` package specifically, it should also include `g` for the sake of completeness.
2015-01-13 03:03:14 +01: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
Parkayun 33534bb4a9 Happy New Year 2015 2015-01-02 11:35:00 +09:00
Sateesh b9eb805167 Update quickstart.rst
Minor grammar correction.
2014-12-30 22:40:13 +05:30
Markus Unterwaditzer bd2c8b631f Fix #1298 2014-12-30 12:08:17 +01:00
Nic Young 29ba05f5be Fix grammar in testing doc. 2014-12-29 22:11:17 -07:00
Wang Haowei 47b5c09ba6 fix typo 2014-12-25 11:52:11 +08:00
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
Kevin Yap 23fc2e56a8 Grammatical fixes in Foreword and Tutorial 2014-12-16 11:30:00 -08:00