Commit graph

136 commits

Author SHA1 Message Date
David Lord
f5038c4c39 f-strings everywhere 2020-04-04 12:10:00 -07:00
Chris Lamb
d3a16a9895 Make the documentation build reproducibly
Whilst working on the Reproducible Builds effort [0] we noticed that
flask could not be built reproducibly.

This is because it includes an absolute build directory in the
documentation as the "json_module" attribute points to a Python class/
module which has a string representation including its path.

This commit skips this (inherited) member from the documentation.

(This was originally filed in Debian as #943674 [1].)

 [0] https://reproducible-builds.org/
 [1] https://bugs.debian.org/943674
2019-10-28 09:16:53 +00:00
David Lord
ff0c92a1c7 Merge branch '1.0.x' 2019-06-23 16:57:52 -07:00
David Lord
363741ec69 fix docks linkcheck 2019-06-23 15:37:51 -07:00
David Lord
316caad5db Merge branch '1.0.x' 2019-05-16 12:18:36 -07:00
Grey Li
e4f8be4ee5 Fix typo in URL defaults example 2019-04-12 09:45:58 +08:00
David Lord
fc7a1c4344 Merge branch '1.0-maintenance' 2019-01-06 10:36:54 -08:00
Mark Amery
7e44691ee3 Clarify and add detail to tojson docs
Fix some confusing and obsolete prose.
2019-01-06 09:44:09 -08:00
Aditya
fa50bdd372 Use https for external links wherever possible 2018-10-27 17:58:45 +05:30
Juan Lara
a256c4d44f Typo in docs
"keeps track on" -> "keeps track of"
2018-06-27 21:49:21 -07:00
David Lord
24b42e895b expand explantion about default redirects 2018-04-27 09:57:30 -07:00
Hampus Dunström
6b352343e2 Added short note about Werkzeug redirect behaviour 2018-04-27 11:40:12 +02:00
David Lord
010156c80a use theme provided by pallets-sphinx-themes 2018-04-18 12:05:31 -07:00
David Lord
aaab1e46f2 add Response.max_cookie_size config 2018-04-10 11:17:18 -07:00
David Lord
119ebf959f rework context docs 2018-04-09 00:02:38 -07:00
David Lord
1679ddbf85 rewrite extension docs
remove old extension patterns
remove flask.ext from api docs
2018-02-28 07:52:03 -08:00
David Lord
8d5c870199 add test_cli_runner for testing app.cli commands 2018-02-19 15:34:46 -08:00
David Lord
f0101de17b load env vars using python-dotenv 2017-07-16 13:37:51 -07: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
Tony Narlock
226e010998 Add docutils label for class-based views 2017-06-12 16:15:52 -05:00
David Lord
1ed4062f8f Merge remote-tracking branch 'remotes/origin/master' into json-mixin 2017-06-04 09:42:39 -07:00
David Lord
9386115d1f finish documentation
[ci skip]
2017-06-02 08:09:37 -07:00
David Lord
389c2c9708 docs style cleanup
[ci skip]
2017-06-02 07:03:22 -07:00
Jeff Widman
84e1e61f8e 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
7ddad080d3 Inherit Werkzeug docs (#2135)
Fix #2132
2016-12-31 16:31:44 +01:00
Markus Unterwaditzer
7b9b5580ee Use abort docs from Werkzeug
Fix #1960
2016-09-18 15:47:52 +02:00
Adam Byrtek
f5f46f56e6 Documentation updates 2016-08-19 21:21:43 +02:00
Armin Ronacher
e3cdb453fd 1.0 -> 0.11 in the docs 2016-05-26 20:52:17 +02:00
Armin Ronacher
4cb36cbafc Update docs to the new CLI patterns 2016-05-26 20:45:50 +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
ThiefMaster
394acf2112 Add pop and setdefault to AppCtxGlobals 2015-06-20 18:04:58 +02:00
Alexander Pantyukhin
069f134d7e Changes and docs are modified. 2015-06-17 15:45:37 +02:00
Markus Unterwaditzer
f097924cfe Deduplicate signals docs
Triggered by #1390
2015-06-10 18:42:55 +02:00
Ford Hurley
8d80857cc0 Mention that custom converters can be defined for url routes 2015-05-01 12:11:55 -04:00
Markus Unterwaditzer
75a7d5b304 Fix broken link 2015-03-05 22:04:53 +01:00
Bruce Sutherland
547acbf3f2 Wrap text. 2015-01-22 09:12:18 +09:00
Bruce Sutherland
3ca13dc1cc Show requested URI as suggested by untitaker. 2015-01-21 20:52:42 +09:00
Bruce Sutherland
479a4c3908 Update api.rst
Changed Japanese text to pi symbol, emphasize that values are unicode.
2015-01-21 15:00:38 +09:00
Bruce Sutherland
59bd9661ba 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
963c51196f Fixed wording 2014-12-09 22:46:10 +05:30
pkuphy
458b7fd572 Update api.rst
is an -> if a
2014-12-05 02:53:30 +08:00
defuz
8be648cfa2 docs: script -> `script` 2014-11-05 07:56:03 +03:00
defuz
6c894b2274 docs: http method names like `GET and POST` 2014-11-05 06:13:01 +03:00
defuz
f7cbe74c35 docs: `True, False and None` 2014-11-05 06:04:58 +03:00
boreq
e5692388cc Added full_path to the Request object documentation. 2014-08-31 18:09:53 +02:00
Paulo Bu
dd00d7d9bc 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
e800f0352d Added some missing documentation information. 2014-08-26 10:03:15 +02:00
Armin Ronacher
ef6ae15126 Refactored the scripting interface greatly. 2014-08-25 16:50:22 +02:00
Armin Ronacher
f7c31e29b0 Greatly refactored click integration and documented it a bit more. 2014-05-07 21:35:51 +02:00
Daniel Neuhäuser
8399008e91 Switch pypi links to https
To which the http version redirects permanently
2014-04-26 01:30:28 +02:00