Commit graph

1641 commits

Author SHA1 Message Date
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
Bill Fienberg
15b2301754
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
b6edad64aa
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
bb63298b71 Typo in docs
"keeps track on" -> "keeps track of"
2018-06-27 21:49:21 -07:00
Gabriel Saldanha
c5af1be70f 🎨 Use set literal instead of set method 2018-06-27 08:58:26 -03:00
Kamil Wargula
c92c1e93c7
Update docs - add command for listing rules. 2018-06-20 14:39:08 +02:00
Grey Li
27e67dafc0
Remove unnecessary period in documentation 2018-06-17 12:12:37 +08:00
ThiefMaster
161c43649d Merge branch '1.0-maintenance' 2018-06-14 13:31:40 +02:00
Saul Urias
0b4296ff17 Fix typo in appcontext.rst 2018-05-29 19:11:30 +02:00
David Lord
79fc8e5c31
Merge pull request #2806 from doobeh/uwsgi_doc_fix
Set uwsgi link to use :ref:
2018-05-28 12:25:06 -07:00
Anthony Plunkett
7cc71cccec Set uwsgi link to use :ref:
Fixes #2802
2018-05-28 15:10:55 -04:00
Tiago Coutinho
c853d11fc5
Update gevent wsgi
gevent.wsgi is deprecated since gevent 1.1 and removed in gevent 1.3. 
gevent.pywsgi should be used instead
2018-05-21 08:10:16 +02:00
Grey Li
07b9ff6e77
Make super() compatible for Python2 2018-05-16 19:13:19 +08: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
Daniel Opitz
676efcc21a Fixed LaTeX errors on documentation PDF generation 2018-05-03 02:01:49 +02:00