jaydarius
42da151fc7
use or to complete the either statement
2019-05-08 10:59:55 -04:00
David Baumgold
6606a4a238
fix RST line too long
2019-05-06 11:11:32 -04:00
David Lord
86bf9dca72
Merge pull request #3103 from tbm/typos
...
Fix typos in the documentation
2019-02-24 06:33:44 -08:00
Martin Michlmayr
7b88b35747
Fix typos in the documentation
2019-02-24 10:40:23 +00:00
Martin Michlmayr
5830388ee2
Fix formatting issue in quickstart guide
...
Due to a formatting issue in the reStructuredText input, the HTML
output produced a description list (<dl>) within the ordered list.
2019-02-23 00:02:01 +00:00
venus
99ad1f3cae
fix the typo
2019-01-12 14:51:04 +08:00
David Lord
ac6746d1be
Merge branch '1.0-maintenance'
2019-01-06 15:46:33 -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
3b45b82ec2
Merge branch '1.0-maintenance'
2019-01-06 10:36:54 -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
Aly Sivji
2b74cf9f2d
Add SPA pattern to docs
2019-01-06 06:19:55 -08:00
David Lord
f7d50d4b67
Merge branch '1.0-maintenance'
2019-01-05 15:12:17 -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
Emlyn Price
5e07e3a6ad
Add comment about using factory function in __init__.py
2019-01-04 22:12:53 +00:00
Oliver Bestwalter
d8400d7cac
Fix typo in class name
2018-12-21 15:36:58 +01:00
Hsiaoming Yang
d5665e4ba6
Merge pull request #2917 from garenchan/docs1
...
Docs: fix some errors in errorhandling.rst
2018-11-28 22:25:21 +09:00
David Lord
dcc02d6e7d
Merge pull request #2976 from cykerway/master
...
Fix inconsistency in testing doc.
2018-11-13 14:06:12 -05: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
Markus Unterwaditzer
339419117f
Fixes for sentry docs ( #2991 )
2018-11-07 21:04:10 +01:00
Adam Walsh
3bf80912cf
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
43e2d7518d
Fix inconsistency in testing doc.
2018-10-29 20:53:39 -04:00
Aditya
f05625eb82
Use https for external links wherever possible
2018-10-27 17:58:45 +05:30
jangjunha
eef6c34b57
Fix deferred callback doc
2018-10-26 00:33:12 +09:00
David Lord
0b7a74dda3
split code and output
2018-09-21 06:05:52 -07:00
garenchan
357b710af2
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
eae6440605
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
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
Jarek Lipski
47dadcfe15
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
0f4c9f1d57
reformat sphinx config
2018-09-17 08:35:53 -07:00
David Lord
ba868d681a
update sphinx config
2018-09-17 08:35:28 -07:00
chengkang
067c772588
remove DocVersion related
2018-09-17 21:05:53 +08:00
chengkang
3e86fd25e9
fix issue: no theme named 'flask' found
2018-09-17 16:18:52 +08:00
Grey Li
21b0aa6dd8
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
b9b88b0cdf
doc reqcontext fix teardown example ( #2892 )
...
* doc reqcontext fix teardown example
* remove comments
2018-08-25 00:12:15 +09:00
cktan98
f45ceec31f
Fix grammatical error
2018-07-25 01:57:30 +08:00
David Lord
345685c014
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
c7791bb526
📚 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
e771016a5b
Fix broken cross-references; use :doc: tags where necessary
2018-07-11 10:12:18 -05:00
