Commit Graph

124 Commits

Author SHA1 Message Date
David Lord 49a38ed999
use theme provided by pallets-sphinx-themes 2018-04-18 12:05:31 -07:00
David Lord 1ed756a523
add Response.max_cookie_size config 2018-04-10 11:17:18 -07:00
David Lord 2411707492
rework context docs 2018-04-09 00:02:38 -07:00
David Lord 4462cc57c8
rewrite extension docs
remove old extension patterns
remove flask.ext from api docs
2018-02-28 07:52:03 -08:00
David Lord cf5525f98a
add test_cli_runner for testing app.cli commands 2018-02-19 15:34:46 -08:00
David Lord 491d331e6e
load env vars using python-dotenv 2017-07-16 13:37:51 -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
Tony Narlock 91fd33dbd9 Add docutils label for class-based views 2017-06-12 16:15:52 -05:00
David Lord dbc70c9274
Merge remote-tracking branch 'remotes/origin/master' into json-mixin 2017-06-04 09:42:39 -07:00
David Lord 9bee2500dd
finish documentation
[ci skip]
2017-06-02 08:09:37 -07:00
David Lord bbd15d53ad
docs style cleanup
[ci skip]
2017-06-02 07:03:22 -07:00
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 49386ee69e Inherit Werkzeug docs (#2135)
Fix #2132
2016-12-31 16:31:44 +01:00
Markus Unterwaditzer dcfdfc6476 Use abort docs from Werkzeug
Fix #1960
2016-09-18 15:47:52 +02:00
Adam Byrtek 5ebdd5dd74 Documentation updates 2016-08-19 21:21:43 +02:00
Armin Ronacher f9ea3fe026 1.0 -> 0.11 in the docs 2016-05-26 20:52:17 +02:00
Armin Ronacher a7d829c618 Update docs to the new CLI patterns 2016-05-26 20:45:50 +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
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
Ford Hurley d398780852 Mention that custom converters can be defined for url routes 2015-05-01 12:11:55 -04:00
Markus Unterwaditzer 9c1cf1bc08 Fix broken link 2015-03-05 22:04:53 +01: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
Prakash Pandey 4d8cba917e Fixed wording 2014-12-09 22:46:10 +05:30
pkuphy fbe3e81818 Update api.rst
is an -> if a
2014-12-05 02:53:30 +08:00
defuz d6f5eb8def docs: `script` -> ``script`` 2014-11-05 07:56:03 +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
boreq 3bd9cdce94 Added full_path to the Request object documentation. 2014-08-31 18:09:53 +02:00
Paulo Bu b81f72070e Fix warnings and code styling in the doc
There was a blank line missing that was generating a warning when
building the doc. Also, a removed function from cli.py was left in api.rst
(without_appcontext specifically) so this was also generating warnings.

Also corrects the format for a code block and adds a link to Werkzeug's Headers
class.
2014-08-28 16:51:53 +02:00
Armin Ronacher afb613ca43 Added some missing documentation information. 2014-08-26 10:03:15 +02:00
Armin Ronacher 932f7d7cbb Refactored the scripting interface greatly. 2014-08-25 16:50:22 +02:00
Armin Ronacher 3569fc2441 Greatly refactored click integration and documented it a bit more. 2014-05-07 21:35:51 +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 f5a02b9495 Added a warning about key sorting 2014-02-08 16:27:26 +00:00
Nicholas Zaccardi ea656a8909 added a note to the api documentation about JSON_SORT_KEYS. Fixes #922 2014-01-24 19:21:24 -06:00
Jochen Kupperschmidt 8246ce6a15 Fixed tiny but distracting typo. 2013-08-11 15:59:46 +02:00
Chris Rebert f632ba25e0 api.rst: fix some spelling/typos 2013-07-22 02:12:17 -07:00
Igor Mozharovsky a225a304b8 Fix typo 2013-06-23 03:36:20 +03:00
Armin Ronacher e2d4aa1207 Added a missing note to the docs 2013-06-09 12:23:14 +01:00
Armin Ronacher c889fbc231 Changed interface for `flask.g`
This now makes it behave like it did before, it's just an object.
It did however gain ``__contains__`` and ``__iter__`` and I added
a ``get()`` method to fetch an attribute without raising an
error.  This fixes #759.
2013-06-09 12:06:33 +01:00
Armin Ronacher 93073489a0 Documented changes on the g object some more 2013-06-05 10:02:33 +01:00
Armin Ronacher 0676bb8ab5 Added appcontext_pushed and appcontext_popped signals 2013-06-05 09:53:26 +01:00
Armin Ronacher ef72b78042 Imply the |safe on tojson in templates and change escaping logic 2013-06-03 12:25:08 +01:00
Armin Ronacher 18673ba370 Added uuid support for new session serialization and documented it 2013-05-14 11:33:36 +01:00
Armin Ronacher 097353695e Added flask.copy_current_request_context which simplies working with greenlets 2013-05-14 11:00:04 +01:00