Commit graph

1034 commits

Author SHA1 Message Date
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
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
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
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
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
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