Martin Michlmayr
93f03eabbb
Fix typos in the documentation
2019-02-24 10:40:23 +00:00
venus
b86b63e435
fix the typo
2019-01-12 14:51:04 +08:00
David Lord
39a8efe484
Merge branch '1.0-maintenance'
2019-01-06 15:46:33 -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
fc7a1c4344
Merge branch '1.0-maintenance'
2019-01-06 10:36:54 -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
Aly Sivji
4ceeb04a1c
Add SPA pattern to docs
2019-01-06 06:19:55 -08:00
David Lord
ca27661d8a
Merge branch '1.0-maintenance'
2019-01-05 15:12:17 -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
Emlyn Price
7c429a182b
Add comment about using factory function in __init__.py
2019-01-04 22:12:53 +00:00
Oliver Bestwalter
76e848be6d
Fix typo in class name
2018-12-21 15:36:58 +01:00
Hsiaoming Yang
b2285991e9
Merge pull request #2917 from garenchan/docs1
...
Docs: fix some errors in errorhandling.rst
2018-11-28 22:25:21 +09:00
David Lord
391b4f1907
Merge pull request #2976 from cykerway/master
...
Fix inconsistency in testing doc.
2018-11-13 14:06:12 -05: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
Markus Unterwaditzer
21704f22cb
Fixes for sentry docs ( #2991 )
2018-11-07 21:04:10 +01:00
Adam Walsh
513bbc06d0
Update sentry error handling documentation ( #2990 )
...
- Change examples to use the Sentry Python SDK: `sentry-sdk`
- Removed the app factory pattern example
- Added a custom exception handling example
2018-11-07 20:25:52 +01:00
Cyker Way
7a09ae3648
Fix inconsistency in testing doc.
2018-10-29 20:53:39 -04:00
Aditya
fa50bdd372
Use https for external links wherever possible
2018-10-27 17:58:45 +05:30
jangjunha
f112dc0aed
Fix deferred callback doc
2018-10-26 00:33:12 +09:00
David Lord
05644138fc
split code and output
2018-09-21 06:05:52 -07:00
garenchan
d1b0d6c770
Fix docs errors
...
1.Grammar error: 'return' should be 'returns'; 'would is' should be
'would be'.
2.Reloader is used to reload and fork process if modules were changed
rather than when an exception occurred.
3.The sample code is not concise enough.
2018-09-21 13:05:06 +08: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
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
Jarek Lipski
df4ca56eac
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 18:55:12 +02:00
David Lord
eed911fa79
reformat sphinx config
2018-09-17 08:35:53 -07:00
David Lord
58a8c456ab
update sphinx config
2018-09-17 08:35:28 -07:00
chengkang
c9b6982843
remove DocVersion related
2018-09-17 21:05:53 +08:00
chengkang
51981d1b4a
fix issue: no theme named 'flask' found
2018-09-17 16:18:52 +08: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
Alexis Benoist
7be1089904
doc reqcontext fix teardown example ( #2892 )
...
* doc reqcontext fix teardown example
* remove comments
2018-08-25 00:12:15 +09:00
cktan98
88d0d793c7
Fix grammatical error
2018-07-25 01:57:30 +08:00
David Lord
cd2e758ae7
Merge pull request #2861 from jwflory/fix/uwsgi-docs
...
[docs] Fix broken Sphinx cross-references; use :doc: tags where necessary
2018-07-20 10:42:09 -07:00
Jeremy Mayeres
ca292373c7
📚 Improve docs about ScriptInfo
...
Improve documentation for the CLI using application factories and
how/when the ScriptInfo object is passed with Application Discovery
2018-07-20 19:20:04 +02:00
Justin W. Flory
82bff7585c
Fix broken cross-references; use :doc: tags where necessary
2018-07-11 10:12:18 -05:00
Bill Fienberg
aa7e42eb03
Fix grammatical error: incorrect verb conjugation
...
Before: >However, as a project *get* bigger
After: >However, as a project *gets* bigger
2018-06-29 14:35:44 -05:00
David Lord
2366cafde9
Merge pull request #2843 from gcrsaldanha/use-set-literal-in-docs
...
🎨 Use set literal instead of set method in file uploading example
2018-06-28 07:22:35 -07:00
Juan Lara
a256c4d44f
Typo in docs
...
"keeps track on" -> "keeps track of"
2018-06-27 21:49:21 -07:00
Gabriel Saldanha
78530d2322
🎨 Use set literal instead of set method
2018-06-27 08:58:26 -03:00