orbit-oss/flask
4
5
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
3603 commits 4 branches 69 tags 37 MiB
Commit graph

152 commits

Author SHA1 Message Date
pgjones
9e0bd76d2a Allow dictionary return values as JSON 
This supports an increasingly common usecase whereby JSON is the
primary response (rather than a templated string). Given Flask has a
short syntax for HTML reponses, it seems fitting that it should also
do so for JSON responses. In practice it allows,

     @app.route("/")
     def index():
         return {
             "api_stuff": "values",
         }
 2019-05-24 09:48:55 -07:00
David Lord
316caad5db Merge branch '1.0.x' 2019-05-16 12:18:36 -07:00
Adam Johnson
00b94d76d5 Fix some HTML injection paths in examples 
These are unlikely to be copy-pasted by users but it's best practice to avoid it and other examples do.
 2019-05-16 09:50:58 -07:00
David Baumgold
3b6d1ecd24 fix RST line too long 2019-05-06 11:11:32 -04:00
Grey Li
89a3e0c915 doc: Improve description for valid view func return value 
* improve wording.
* remove unnecessary spaces.
 2019-03-06 10:34:21 +08:00
Martin Michlmayr
534bad66d8 Fix formatting issue in quickstart guide 
Due to a formatting issue in the reStructuredText input, the HTML
output produced a description list (<dl>) within the ordered list.
 2019-02-23 00:02:01 +00:00
David Lord
05644138fc split code and output 2018-09-21 06:05:52 -07:00
Tom Busby
d75c3c253e Make script output into comments to not break syntax highlighting 
http://flask.pocoo.org/docs/1.0/quickstart/#url-building

In the URL Building section of the quickstart, the script output is shown right after the code.

This breaks syntax highlighting for the whole code-block. To fix this, I have made the output into comments.
 2018-09-19 23:42:35 +02: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
Daiana Marasquin
fce4f839e2 fix syntax error and typo in quickstart.rst 2018-04-29 14:51:13 -07:00
David Lord
7ccc8fb877 rewrite quickstart Unique URLs section 2018-02-24 08:03:30 -08:00
David Lord
b2de7b49a7 clean up FLASK_ENV docs [ci skip] 2018-01-10 15:46:11 -08:00
Armin Ronacher
a1afc8f1a7 Add Support for FLASK_ENV (#2570) 
This introduces environments to Flask
 2018-01-06 17:07:56 +01:00
Vladimir Kroz
2c94dd3a86 Fix code example for HTTP Methods 
`return` is required to make 'http methods' example work
 2017-12-05 17:59:04 +01:00
David Lord
d590d6024d 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
Levi Roth
63d6106d87 Added documentation for PowerShell environment variables 2017-05-23 14:30:39 -04:00
Tully Rankin
88e880ed42 Removed the version number out of the documenation link to Werkzeug. 2017-05-22 12:19:52 -07:00
Tully Rankin
1a3a9dcefb Added link to using Werkzeug debugger in quickstart documentation. 2017-05-22 12:14:52 -07:00
David Lord
35428d04a8 wrap lines 
tighten up wording
remove any converter from quickstart
use correct rst code syntax
 2017-05-11 22:31:19 -07:00
Xephyr826
49e263937a 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
Jan Ferko
7664e605ba 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
Jeff Widman
2ad2aadb88 Migrate various docs links to https (#2180) 
Also fixed a few outdated links
 2017-02-11 10:43:11 +01:00
Swan Htet Aung
8ac70e1719 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
Dennis Chen
b57c88e154 Fix Request Reference (#2151) 
Points flask.Request to appropriate place in the documentation.
 2017-01-14 21:58:45 +01:00
Michael Recachinas
d544a46a7d 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
dawran6
faded8c5c7 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
David Lord
d775103a03 clean up code formatting in some docs 
fix warnings while building docs
 2016-06-26 13:03:29 -07:00
David Lord
77cfb9b226 remove unnecessary form action attributes 2016-06-22 15:01:41 -07:00
Markus Unterwaditzer
ae5bc44987 quickstart: Remove reference to python hello.py 
Fix #1826
 2016-05-29 15:46:48 +02:00
Armin Ronacher
4cb36cbafc Update docs to the new CLI patterns 2016-05-26 20:45:50 +02:00
bagratte
de4e0a553c minor revision of documentation. 2016-04-01 23:12:25 +02:00
lord63
3fa60187ce 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
Markus Unterwaditzer
89de9cb967 Fix #1195 2015-06-06 06:25:41 +02:00
Justin Poehnelt
7af629354e fixed import of werkzeug secure_filename 2015-05-14 23:44:49 -07:00
Phil Schaf
55c0900452 Added docs for the error handler rework 2015-04-11 17:25:17 +02:00
Winston Kouch
34c3adf33c Add extensions section to Quickstart documentation 2015-03-11 23:54:09 -04:00
Carlos Eduardo Rivera
82765c7551 grammar fixes 2015-01-16 03:36:17 -06:00
Sateesh
4f4c0cd801 Update quickstart.rst 
Minor grammar correction.
 2014-12-30 22:40:13 +05:30
Markus Unterwaditzer
b554c644c0 Merge branch 'flask_deployment_docs' 
Conflicts:
	docs/quickstart.rst
 2014-12-04 22:39:28 +01:00
defuz
e4043cfb11 docs: :exc:TypeError 2014-11-05 08:16:27 +03:00
defuz
b9d849475d docs: :mimetype:application/json 2014-11-05 07:43:00 +03:00
defuz
62019cf705 docs: `with, for, self` 2014-11-05 07:39:54 +03:00
defuz
22c36770b1 docs: :file:/var/www/foo, `/static` 2014-11-05 07:19:02 +03:00
defuz
ec806c1bbe docs: :command:pip, :option:--debug 2014-11-05 07:03:55 +03:00
defuz
b5c9ad68dd docs: :file:app.py, :file:yourapp/templates 2014-11-05 06:45:22 +03:00
defuz
6c894b2274 docs: http method names like `GET and POST` 2014-11-05 06:13:01 +03:00
Petr Zemek
9c229ef0fa Unify the uses of "file system" vs "fileystem". 
Use "filesystem", which is more prevailing in the source code.
 2014-10-27 11:33:45 +01:00
Markus Unterwaditzer
4b8a73c652 Fix broken link 2014-10-26 02:01:42 +02:00
Kevin Funk
41f55195e8 Update quickstart.rst 
url converters: match the [API docs](http://flask.pocoo.org/docs/0.10/api/#url-route-registrations)
 2014-09-19 15:22:37 -07:00
Markus Unterwaditzer
f034ee88d5 Rewrite deployment docs 2014-09-06 22:20:02 +02:00