Commit graph

1269 commits

Author SHA1 Message Date
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
jordan bonser
342fbe6fe7 improve env vars config example 2019-05-16 08:48:34 -07:00
David Lord
26d79e5632 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
e4f8be4ee5 Fix typo in URL defaults example 2019-04-12 09:45:58 +08: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
venus
3736f27760 fix the typo 2019-01-12 21:42:06 +09:00
David Lord
091ada7da3 remove encoding from method override pattern 2019-01-07 13:09:36 -08:00
David Lord
141373fdd0 simplify mongoengine doc, redirect from mongokit 2019-01-06 15:42:08 -08:00
Igor Ghisi
1643efd81f 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
0a0d0e1017 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
564faabda1 clarify where to call flask run from in tutorial 2019-01-06 15:10:38 -08:00
Stephon Harris
ee861266dc Adding conjunction where for clarification 2019-01-06 15:05:54 -08:00
nathanbegbie
7b00a51acc 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
da19d8a914 Docs: fix some typos in config.rst 2019-01-06 14:45:10 -08:00
Douglas Thor
fad04d2547 document that Config.from_object uses object as-is 2019-01-06 14:34:05 -08:00
David Lord
7f013c7a3c use "-m virtualenv" in installation doc 2019-01-06 10:25:16 -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
David Lord
f4076ad5ff 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
0c011a4c15 Fix typos found while completing the Flask tutorial 2019-01-06 08:01:45 -08:00
Colin Adams
e0916c7d0d 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
6b11d22427 Merge pull request #3064 from pallets/docs-fix
fix docs build
2019-01-05 15:06:41 -08:00
David Lord
a97c5c75c7 fix docs build 2019-01-05 14:59:25 -08:00
Andrew Crouse
b2bcf461c4 Update documentation for users to use flask-caching instead of the deprecated Werkzeug cache 2018-11-13 14:03:27 -05:00
jangjunha
f112dc0aed Fix deferred callback doc 2018-10-26 00:33:12 +09:00
Jarek Lipski
1a31fc71f6 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
751a5fa4a4 Merge branch '0.12-maintenance' into 1.0-maintenance 2018-05-08 20:31:10 -07:00
Daniel Opitz
1394ec46f4 Fixed LaTeX errors on documentation PDF generation 2018-05-08 20:30:36 -07:00
David Lord
04a158c2f9 clarify the section navigation in installation 2018-05-08 20:10:27 -07:00
Mitchel Humpherys
729463dbd9 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
e2018cb2d9 add missing port to localhost URL 2018-04-30 19:03:05 -07:00
David Lord
fe243d0a09 Merge pull request #2745 from dmarasquin/patch-1
Update quickstart.rst
2018-04-29 14:57:24 -07:00
Daiana Marasquin
fce4f839e2 fix syntax error and typo in quickstart.rst 2018-04-29 14:51:13 -07:00
David Lord
eb52ca4625 rename to FLASK_SKIP_DOTENV, add docs, test 2018-04-29 14:20:17 -07:00
Yao Long
ddeb9c370f 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
1b609c4dfe 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
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
e1edf61dc0 fix docs index sidebar 2018-04-26 15:15:55 -07:00
David Lord
eeca1c6bfd fix docs index sidebar 2018-04-26 15:15:31 -07:00
David Lord
44b13e7e39 fix docs logo 2018-04-26 13:06:15 -07:00
David Lord
1a459e949c Merge branch '0.12-maintenance' 2018-04-26 12:18:06 -07:00
David Lord
d86103c79d add donate link 2018-04-26 07:46:50 -07:00
David Lord
e02118dbc9 add donate link 2018-04-26 07:44:59 -07:00
David Lord
8ab7d3abc3 add donate link 2018-04-26 06:05:13 -07:00
David Lord
30f03a93d8 add donate link 2018-04-26 06:03:33 -07:00
Grey Li
da9e61f0b3 Fix typo in docs 2018-04-24 08:09:08 +08:00
David Lord
cbf2a4245c document cli option env vars
closes #2713
2018-04-20 13:25:04 -07:00
David Lord
d5108acf27 enable intersphinx 2018-04-18 13:10:56 -07:00
David Lord
db01b7350c use theme provided by pallets-sphinx-themes 2018-04-18 13:06:08 -07:00
David Lord
010156c80a use theme provided by pallets-sphinx-themes 2018-04-18 12:05:31 -07:00