Commit graph

1281 commits

Author SHA1 Message Date
David Lord
cb6272ccc8
fix docks linkcheck 2019-06-23 15:37:51 -07:00
David Lord
28b35c55a1
update docs config 2019-06-23 12:27:25 -07:00
David Lord
7d77958000
use sphinx-issues, rewrap changelog 2019-06-23 12:25:38 -07:00
David Lord
e666f7a69c
standardize license and copyright 2019-06-22 13:09:09 -07:00
David Lord
146df0f9e8
use dashes for command names 2019-06-21 08:47:27 -07:00
David Lord
4b519f0e33
reword api error section 2019-06-12 11:02:53 -07:00
Logan Wright
7bc965fada
adds api error handling documentation 2019-06-12 10:54:12 -07:00
Diego Alberto Torres Quintanilla
45b2e7702d Guard against missing request context in logging docs. 2019-05-31 14:54:03 -04:00
brunoais
6142aa64ae
More explicit explanation: session testing
Use a more explicit explanation on how to write code to test own code
when sessions are needed.
The previous code was not fully explicit that the client is supposed
to be called after the session transaction and not during.
2019-05-16 18:07:18 -07:00
A Brooks
4e272fc042
Fix various small spelling errors. 2019-05-16 11:50:10 -07:00
Charles Ross
0df2620c5f
update docs on gunicorn deploy and app discovery 2019-05-16 10:45:03 -07:00
Tom-McDonald
994cd1db33
replaced deprecated sample code in proxy-setup docs 2019-05-16 09:54:49 -07:00
Adam Johnson
e5b0fe6841
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
jordan bonser
800c744fe7
improve env vars config example 2019-05-16 08:48:34 -07:00
David Lord
42b67a1f95
Merge pull request #3150 from greyli/fix-route-defaults-doc
[Doc] Fix typo in code example for route defaults
2019-04-11 19:11:21 -07:00
Grey Li
4df7b220fa Fix typo in URL defaults example 2019-04-12 09:45:58 +08:00
Grey Li
d838f1c918 doc: Improve description for valid view func return value
* improve wording.
* remove unnecessary spaces.
2019-03-06 10:34:21 +08:00
venus
8c979698bd fix the typo 2019-01-12 21:42:06 +09:00
David Lord
2c29495e6d
remove encoding from method override pattern 2019-01-07 13:09:36 -08:00
David Lord
edef8cb38b
simplify mongoengine doc, redirect from mongokit 2019-01-06 15:42:08 -08:00
Igor Ghisi
4e280b4142
Replace MongoKit by MongoEngine on docs
Docs chapter "Patterns for Flask" has a section dedicated to MongoKit,
but MongoKit lib seems unmaintained and is not compatible with recent
versions of PyMongo.

This commit replaces MongoKit guide with a new one using MongoEngine.

Closes #2907
2019-01-06 15:12:53 -08:00
David Lord
b2765893e6
Merge pull request #3067 from pallets/tutorial-flask-run
clarify where to call flask run from in tutorial
2019-01-06 15:11:30 -08:00
David Lord
d6151340bc
clarify where to call flask run from in tutorial 2019-01-06 15:10:38 -08:00
Stephon Harris
ab7f9e735f
Adding conjunction where for clarification 2019-01-06 15:05:54 -08:00
nathanbegbie
b8e461e3d1
Update docs on larger applications wrt tutorial
The wording of the docs makes it sound like the tutorials use the simple structure for a flask application, which they no longer do.
This commit re-words the docs to make it clearer.
2019-01-06 14:53:03 -08:00
garenchan
5409606c3b
Docs: fix some typos in config.rst 2019-01-06 14:45:10 -08:00
Douglas Thor
830c77cb44
document that Config.from_object uses object as-is 2019-01-06 14:34:05 -08:00
David Lord
40e064fa27
use "-m virtualenv" in installation doc 2019-01-06 10:25:16 -08:00
Mark Amery
24325ecb69
Clarify and add detail to tojson docs
Fix some confusing and obsolete prose.
2019-01-06 09:44:09 -08:00
David Lord
aef4159588
Merge pull request #3031 from jseldess/fix-typos
Fix typos found while completing the Flask tutorial
2019-01-06 08:11:39 -08:00
Jesse Seldess
90aef1b2cf
Fix typos found while completing the Flask tutorial 2019-01-06 08:01:45 -08:00
Colin Adams
4f638b9c28
Clarify prefixing of URLs for blueprint endpoints
Clarify that endpoint names are prefixed by the name of the blueprint,
but the URL is not automatically prefixed.
2019-01-06 06:58:38 -08:00
David Lord
1096e226cc
Merge pull request #3064 from pallets/docs-fix
fix docs build
2019-01-05 15:06:41 -08:00
David Lord
8b567fea23
fix docs build 2019-01-05 14:59:25 -08:00
Andrew Crouse
aec0cdc016
Update documentation for users to use flask-caching instead of the deprecated Werkzeug cache 2018-11-13 14:03:27 -05:00
jangjunha
eef6c34b57 Fix deferred callback doc 2018-10-26 00:33:12 +09:00
Jarek Lipski
363205bdc3
fix @click.command example by adding parens
Otherwise the example fails with the following error: 
"name = name or cmd.name AttributeError: 'function' object has no attribute 'name'". 

More details: https://stackoverflow.com/a/51923415/4619705
2018-09-19 10:02:51 -07:00
David Lord
a35a97e49d
Merge branch '0.12-maintenance' into 1.0-maintenance 2018-05-08 20:31:10 -07:00
Daniel Opitz
1c2a2cd001
Fixed LaTeX errors on documentation PDF generation 2018-05-08 20:30:36 -07:00
David Lord
335dcf8ec4
clarify the section navigation in installation 2018-05-08 20:10:27 -07:00
Mitchel Humpherys
725f391399
docs: installation: Add link to Quickstart after install
Once Flask is installed many users will want to proceed to the next section
in the docs (Quickstart).  Add a link to the end of the Install section for
this.
2018-05-08 19:59:25 -07:00
Aaron Hall, MBA
5a75da5471
add missing port to localhost URL 2018-04-30 19:03:05 -07:00
David Lord
6b2127b1e0
Merge pull request #2745 from dmarasquin/patch-1
Update quickstart.rst
2018-04-29 14:57:24 -07:00
Daiana Marasquin
104808b480
fix syntax error and typo in quickstart.rst 2018-04-29 14:51:13 -07:00
David Lord
5965cb7e1c
rename to FLASK_SKIP_DOTENV, add docs, test 2018-04-29 14:20:17 -07:00
Yao Long
9b6878af5a
document error on fileupload
after file uploaded, it should redirect for uploaded_file page instead
of upload page
2018-04-27 11:04:35 -07:00
Vik
9394c389bf
Update config.rst
Fix Debug Default: By default Debug is only True when ENV is 'development'
2018-04-27 10:17:43 -07:00
David Lord
5d00869aa5
expand explantion about default redirects 2018-04-27 09:57:30 -07:00
Hampus Dunström
a2536e1bdb Added short note about Werkzeug redirect behaviour 2018-04-27 11:40:12 +02:00
David Lord
3f81582d5d
fix docs index sidebar 2018-04-26 15:15:55 -07:00