Commit Graph

1327 Commits

Author SHA1 Message Date
David Lord 2ede0b8ba9
add donate link 2018-04-26 07:44:59 -07:00
David Lord 4137aecca9
add donate link 2018-04-26 06:05:13 -07:00
David Lord 44dc32243e
add donate link 2018-04-26 06:03:33 -07:00
Grey Li 7df3524bb9
Fix typo in docs 2018-04-24 08:09:08 +08:00
David Lord 93698b509b
document cli option env vars
closes #2713
2018-04-20 13:25:04 -07:00
David Lord 84efe4de77
enable intersphinx 2018-04-18 13:10:56 -07:00
David Lord 679bf0014f
use theme provided by pallets-sphinx-themes 2018-04-18 13:06:08 -07:00
David Lord 49a38ed999
use theme provided by pallets-sphinx-themes 2018-04-18 12:05:31 -07:00
David Lord 1e84c67beb
clean up js example 2018-04-12 12:17:14 -07:00
David Lord fce1885f76
add javascript ajax example 2018-04-12 11:06:02 -07:00
David Lord 1ed756a523
add Response.max_cookie_size config 2018-04-10 11:17:18 -07:00
Grey Li 2f9be68a81
Add tips for 413 connection reset issue 2018-04-09 01:30:15 -07:00
David Lord abba4b2a74
Merge pull request #2686 from davidism/bp-static
document blueprint static folder without prefix
2018-04-09 01:27:25 -07:00
David Lord 46dc14664f
document blueprint static folder without prefix 2018-04-09 01:11:46 -07:00
David Lord c3dd7b8e4c
rewrite tutorial docs and example 2018-04-09 00:53:25 -07:00
David Lord 2411707492
rework context docs 2018-04-09 00:02:38 -07:00
David Lord 4462cc57c8
rewrite extension docs
remove old extension patterns
remove flask.ext from api docs
2018-02-28 07:52:03 -08:00
David Lord 303a3d24a6
rewrite quickstart Unique URLs section 2018-02-24 08:03:30 -08:00
David Lord 82f0d120de
use subdomain arg in url_map.bind_to_environ
rename new subdomain test, parametrize
test allowing subdomains as well as ips
add subdomain_matching param to docs
add some references to docs
add version changed to create_url_adapter
2018-02-23 08:39:31 -08:00
David Lord cf5525f98a
add test_cli_runner for testing app.cli commands 2018-02-19 15:34:46 -08:00
David Lord 310fbfcf64
revert copyright year to project start
add copyright header to files
2018-02-08 12:43:30 -08:00
David Lord 9bf5c3b3a3
update project metadata
new readme
readme as setup.py long_description
links in changes
git in authors
add travis osx env
break out docs build in travis
remove python_requires for now
2018-02-08 12:43:22 -08:00
David Lord ae30fe7de0
document testing cli commands 2018-01-28 18:48:39 -08:00
David Lord 7fb2ddcaf6
add note about syntax errors in custom scripts
mention pycharm version support
2018-01-28 14:41:47 -08:00
David Lord 213afec771
add rst extension for changelog
fix changelog version
2018-01-23 15:34:52 -08:00
David Lord 382b13581e
clean up samesite docs 2018-01-23 15:11:50 -08:00
Fadhel_Chaabane a1d9ebe4ab New Feature: Added Support for cookie's SameSite attribute. 2018-01-23 13:57:50 +00:00
Nickatak a9646716d2 Fix typo in example. 2018-01-14 16:02:43 -08:00
David Lord 87c2e121e0
clean up FLASK_ENV docs [ci skip] 2018-01-10 15:46:11 -08:00
Armin Ronacher 2433522d29
Add Support for FLASK_ENV (#2570)
This introduces environments to Flask
2018-01-06 17:07:56 +01:00
Hsiaoming Yang 60eecb547d Remove python 2.6 and 3.3 everywhere. (#2583) 2018-01-06 10:49:50 +01:00
David Lord 54f3d2131d
Merge pull request #2541 from nsiregar/#2535_update_pycharm_instruction
update pycharm instructions
2018-01-04 12:56:38 -08:00
David Lord c11fe5d007
smaller, optimized image
reword / reformat the docs
fix tox build directory
2018-01-04 12:34:25 -08:00
Grey Li 94fd3edf31
Docs: Update CLI for factory pattern 2017-12-20 20:50:45 +08:00
David Lord a43a439c7a
Merge pull request #2536 from greyli/patch-4
Docs: update built-in server description
2017-12-16 07:08:31 -08:00
David Lord 05e3840cc2
Merge pull request #2555 from pallets/deprecate-26-33
remove tests and docs for python 2.6 and 3.3
2017-12-16 07:06:54 -08:00
David Lord 28d0f66c1f
remove tests and docs for python 2.6 and 3.3 2017-12-16 07:00:00 -08:00
Andy Craze 1cdfe0e5e9
Fix sentry raven install docs
The documentation for installing Sentry's raven client was incorrect. It should state that the client must be installed with the extra flask dependencies as mentioned in getsentry/raven-python#1075
2017-12-14 19:45:09 -08:00
Grey Li 58ea360d43
Docs: Add missing backslash 2017-12-14 14:38:37 +08:00
Grey Li 8a5e389da0
Docs: Fixed typo 2017-12-14 11:08:33 +08:00
Harry Moreno 2d2c0169d4
Fix docs, how to get db connection in pattern
The docs are inaccurately suggestion a db connection would be available at `g.db`, after calling `get_db()` a connection will be available at `g._database` but even then I think instructing the user to use `get_db()` is the best way forward.
2017-12-08 15:18:02 -05:00
Vladimir Kroz d08d96acbc Fix code example for HTTP Methods
`return` is required to make 'http methods' example work
2017-12-05 17:59:04 +01:00
Ngalim Siregar 5892a6f2c5 Update PyCharm image
add highlighted area to pycharm image
2017-12-03 17:05:20 +09:00
Ngalim Siregar 601cd90fdb
update pycharm instructions 2017-12-03 16:37:52 +09:00
Grey Li 602c771327
Docs: update built-in server description 2017-12-01 16:03:52 +08:00
Per Mortensen 110a752565 Update Twisted Web example 2017-11-22 22:40:23 +01:00
Bogdan Alexandru Marginean b89cf95816 Update appfactories.rst 2017-10-19 22:32:47 +03:00
Radoslav Gerganov 9291ead32e Fix typo in logging.rst (#2492)
Remove extra parenthesis from RequestFormatter constructor.
2017-10-13 13:53:50 +02:00
Mrn Om c352714478 Fix grammar/typos 2017-10-11 16:47:26 +03:00
David Lord 9bc329c0c9
rewrite cli docs
reflects the current FLASK_APP detection
2017-10-10 11:10:20 -07:00
ImgBotApp ff8f525fb3 [ImgBot] optimizes images
\docs\_static\no.png (18.3%))
\docs\_static\touch-icon.png (64.21%))
\docs\_static\flaskr.png (8.32%))
\docs\_static\pycharm-runconfig.png (14.65%))
\docs\_static\debugger.png (2.79%))
\docs\_static\flask.png (30.15%))
\docs\_static\yes.png (13%))
\docs\_static\logo-full.png (29.33%))
2017-09-12 04:24:35 +00:00
Brett Johnson e4928323f2 Update App Engine link
Point to an authoritative site for Flask on App Engine that is maintained.
2017-08-30 14:58:05 -07:00
Alejandro Mantecon Guillen 154c621237 Update debugger and flaskr screenshots (#2454) 2017-08-25 15:36:26 +02:00
Brennan Vincello 7640a1f1c9 Add version warning 2017-08-10 21:51:02 -07:00
David Lord 97ad085912
fix links 2017-08-01 08:47:56 -07:00
David Lord 1c35b98f0b
fix code block 2017-08-01 08:39:42 -07:00
David Lord 2efb565fbc
mention that session signature checks max age
add expiration to cookie security docs
closes #2422
2017-08-01 08:28:32 -07:00
David Lord 66b1b752da
simplify logging configuration
single default handler and formatter
don't remove handlers
configure level once using setLevel
document logging
reorganize logging tests
2017-07-31 12:49:03 -07:00
David Lord 417bc336de
egg_info -R flag is gone 2017-07-27 07:32:03 -07:00
David Lord 851eaa4db7 Merge pull request #2416 from davidism/dotenv
Add .env support
2017-07-16 13:55:18 -07:00
David Lord 491d331e6e
load env vars using python-dotenv 2017-07-16 13:37:51 -07:00
asmith26 8e2ef5bde3 Fix typo in docs (#2419) 2017-07-16 21:07:25 +02:00
David Lord 8207b1563e
fix formatting
-R is no longer an egg_info option
closes #2400
[ci skip]
2017-06-28 19:55:39 -07:00
David Lord 01e2d80660
one more secret key in docs 2017-06-28 08:02:51 -07:00
David Lord 465922e5f1
clean up secret key docs
consistent key across docs and examples
consistent key across tests, set in conftest
2017-06-28 07:58:06 -07:00
trirpi bfc2ee7dfd removed bug in memory sqlite uri 2017-06-16 21:15:33 +02:00
David Lord 448368e226
style cleanup
[ci skip]
2017-06-16 06:59:37 -07:00
Miguel Grinberg 0b80acb25c
document wsgi.py and app.py default modules 2017-06-15 12:15:38 -07:00
David Lord e97f6e22e6 Merge pull request #2370 from tony/patch-2
Add docutils label for class-based views
2017-06-13 06:28:18 -07:00
Tony Narlock 91fd33dbd9 Add docutils label for class-based views 2017-06-12 16:15:52 -05:00
Tony Narlock 66e9dc9df2 Add docutils label for templates page 2017-06-12 16:07:24 -05:00
David Lord 01d2f725d3
formatting
[ci skip]
2017-06-09 10:28:54 -07:00
tristan fisher 53ff054fd3 Fixes grammar and phrasing on envvar how-to 2017-06-09 10:54:47 -04:00
tristan fisher 067686b471 Add basic how-to on using envvars for config 2017-06-09 10:19:08 -04:00
David Lord 15756da1f0
mention csp for javascript: uri xss
closes #2174
[ci skip]
2017-06-06 09:21:44 -07:00
David Lord e97253e4c1
clean up JSON code and docs 2017-06-04 11:44:00 -07:00
David Lord dbc70c9274
Merge remote-tracking branch 'remotes/origin/master' into json-mixin 2017-06-04 09:42:39 -07:00
David Lord 9bee2500dd
finish documentation
[ci skip]
2017-06-02 08:09:37 -07:00
David Lord bbd15d53ad
docs style cleanup
[ci skip]
2017-06-02 07:03:22 -07:00
David Lord 859d9a9d5c
show nice message when registering error handler for unknown code
clean up error handler docs
closes #1837
2017-05-31 18:04:08 -07:00
David Lord 045dccaefb
make debugging bad key errors easier
* TRAP_BAD_REQUEST_ERRORS is enabled by default in debug mode
* BadRequestKeyError has the key in the description in debug mode

closes #382
2017-05-29 19:08:25 -07:00
David Lord abf54c8182
fix some config names in new doc 2017-05-29 10:29:06 -07:00
David Lord 60feecc26c
reformat config from table to linkable sections 2017-05-28 14:04:18 -07:00
David Lord 3c7625e8c0
update development resources
fix tox to test examples again
add detox tox env for faster testing
clean up makefile, add tox target
add extra group for installing dev requirements
clean up contributing doc, build with docs
expand issue template
add pull request template
2017-05-28 10:26:07 -07:00
David Lord d2a46dc56d
fix doc build error 2017-05-27 10:43:57 -07:00
David Lord 8eff9bda3d
clean up security header docs
[ci skip]
2017-05-27 10:09:23 -07:00
Kenneth Reitz 63ddf2d479 Merge pull request #1887 from zevaverbach/patch-1
enumerates the states in which code is executed...
2017-05-25 14:47:20 -07:00
Kenneth Reitz 3acec5f801 Merge pull request #2309 from aqt01/master
Add http headers security notes
2017-05-25 14:44:23 -07:00
Lowell Abbott fcfd031460 Add capitalize and other details 2017-05-25 14:42:42 -07:00
Kenneth Reitz 386ac92bdd use alabaster 2017-05-25 17:38:26 -04:00
Kenneth Reitz 4eca29f68b Merge pull request #2080 from pallets/sphinx_theme
switch to packaged sphinx theme
2017-05-25 14:36:06 -07:00
Kenneth Reitz 31174fecd2 resolve merge conflicts 2017-05-25 17:21:32 -04:00
David Lord a4ae7f4d3c Merge pull request #2334 from zebpalmer/master
Docs sidebar missing space
2017-05-25 10:06:53 -07:00
Zeb Palmer 749ef01831 Missing Space
Smallest PR ever, but that missing space has been annoying me for a very long time.
2017-05-25 10:53:43 -06:00
David Lord c5be20b53c Merge pull request #2332 from doobeh/pycharm-config
PyCharm Run Configuration Guide
2017-05-25 09:52:46 -07:00
Dave 7e14f6706a Fix typo 2017-05-25 10:04:10 +05:30
Anthony Plunkett f52f3ef31d PyCharm Run Configuration Guide 2017-05-24 18:50:25 -07:00
Dave Morse 50c6df7098 Minor edits to tutorial for clarity. (#2330) 2017-05-24 17:00:20 -07:00
David Lord 898c8621b1 Merge pull request #2315 from leviroth/powershell-docs
Added documentation for PowerShell environment variables
2017-05-23 15:33:59 -07:00
bovarysme fe27d04cc1 Fix a small oversight in the testing docs 2017-05-23 22:22:16 +02:00
Lowell Abbott 09a0d2ebd1 Re-order by semantic. Fix link on flask-talismand and re-word many concepts 2017-05-23 12:26:43 -07:00
David Lord cd593bf117 Merge pull request #2307 from neilvictorgrey/master
For Issue #2286: Update unittest references
2017-05-23 11:50:31 -07:00
David Lord 8858135043 Update testing.rst 2017-05-23 11:50:14 -07:00
Levi Roth 954d9ca0b8 Added documentation for PowerShell environment variables 2017-05-23 14:30:39 -04:00
Lowell Abbott ee7cb9d6b2 Suggest only one package, change the sourcecode block to none 2017-05-23 01:54:06 -07:00
Lowell Abbott c47f4530a1 Erased duplicated links on title 2017-05-22 23:54:28 -07:00
Lowell Abbott 98b0f96a98 Fix typos, semantics and some other corrections 2017-05-22 23:48:35 -07:00
Lowell Abbott 8459cedaa9 Add security headers notes 2017-05-22 20:52:02 -07:00
Neil Grey 378a11f992 For Issue #2286: Updating test_flaskr to use yield inside fixture 2017-05-22 18:22:08 -07:00
Tully Rankin 65b61aa7c2 Added uWSGI and example usage to stand-alone WSGI containers documentation (#2302) 2017-05-22 18:08:40 -07:00
Neil Grey 4e9d51b39b For Issue #2286: Fixing indenting of test_login_logout 2017-05-22 17:42:30 -07:00
Neil Grey 65fc888172 For Issue #2286: Replaces references to unittest in the documentation with pytest 2017-05-22 17:36:55 -07:00
Tully Rankin 2b96052240 Moved mod_wsgi under uwsgi in TOC deployment docs. 2017-05-22 15:13:31 -07:00
Tully Rankin d7d21f5559 Moved WSGI-Standalone above mod_wsgi in deployment documentation. 2017-05-22 14:48:24 -07:00
Tully Rankin 50b73f967b Removed the version number out of the documenation link to Werkzeug. 2017-05-22 12:19:52 -07:00
Tully Rankin 409dd15c10 Added link to using Werkzeug debugger in quickstart documentation. 2017-05-22 12:14:52 -07:00
Tully Rankin 041c68f48b Updated request context documentation. 2017-05-22 11:28:58 -07:00
Tully Rankin c590e820aa Updated documentation. Replaced term development mode with debug mode. #2261 2017-05-22 11:25:02 -07:00
David Lord d5a88bf0d3
explain when to use a task queue
remove deprecated abstract attr from celery
add explanation of example task
[ci skip]
2017-05-15 12:40:09 -07:00
David Lord f13e3fc352
Merge branch 'master' into celery-documentation 2017-05-15 12:17:09 -07:00
David Lord cc59f2b204
clean up deferred callback doc
remove doc about writing after_this_request
[ci skip]
2017-05-11 22:48:21 -07:00
David Lord 0420cb21db Merge pull request #1965 from vioan/master
Added a missing module to import statement
2017-05-11 22:38:36 -07:00
David Lord c01ddc59b7 Merge pull request #2277 from jlara310/master
Improve quickstart's Routing section
2017-05-11 22:32:00 -07:00
David Lord 2592f927a0
wrap lines
tighten up wording
remove any converter from quickstart
use correct rst code syntax
2017-05-11 22:31:19 -07:00
David Lord 1fb43e3be4
rewrite installation docs
discuss python version
discuss all dependencies
prefer python 3 in instructions
[ci skip]
2017-05-11 14:34:09 -07:00
Xephyr826 dfb03c5673 Improve Routing section
Edited the entire section for clarity and concision. I rewrote sentences
to make them shorter and to reduce ambiguity.

Added a code sample to show the path converter type

Removed the HTTP method overview. Although it was well written, the
overview wasn't necessary in the quickstart. Readers can easily find an
overview elsewhere.
2017-05-10 22:38:22 -07:00
David Lord 5b83f11398 Merge pull request #2213 from runartrollet/doc_virtenv_p3
Issue #2212: documentation: virtualenv and python3
2017-05-09 11:04:23 -07:00
David Lord d2a0b2911b Merge pull request #2210 from Larivact/patch-2
Clarify APPLICATION_ROOT documentation
2017-05-09 08:47:23 -07:00
David Lord 17685da8c0 Merge pull request #1942 from jmsdvl/fix-1935
clarify blueprint 404 error handling in docs
2017-05-09 08:44:58 -07:00
David Lord 75b85656dd
optionally enable sphinxcontrib.log_cabinet
collapses old changelog directives
closes #1704
closes #1867
2017-05-04 18:24:04 -07:00
David Lord 011a4b1899
clean up error handler docs 2017-04-30 08:20:13 -07:00
Benjamin Liebald 6032c94aeb
Mention existence of register_error_handler in errorpages.rst
See https://github.com/pallets/flask/issues/1837 for context.
2017-04-30 07:55:54 -07:00
David Lord f22da31e7f Merge pull request #2191 from SergioDS/master
Updated documentation for being able to use init_db method
2017-04-21 11:45:16 -07:00
David Lord cfd3e50ab6
use app.testing property instead of config 2017-04-14 05:26:29 -07:00
David Lord 03857cc48a
use app.testing property instead of config 2017-04-13 16:32:44 -07:00
accraze 1caa9de628
Added missing testing config
fixes #1302
2017-04-13 16:27:58 -07:00
ka7 e13eaeeaf2 Fix typo in docs (#2237) 2017-04-11 21:44:32 +02:00
Grey Li ec18fe9477 Add example for virtualenv integration in cli docs (#2234) 2017-04-07 07:10:43 -07:00
Adam Geitgey ae1ac2053b Correct imports in file upload example (#2230)
The example code uses `flash` but doesn't import it. So the code as written doesn't work.

This simply adds `flash` to the list of imports in the sample code.
2017-04-04 22:26:40 +02:00
Runar Trollet Kristoffersen 889c0ed196 Issue #2212: documentation: virtualenv and python3 2017-03-19 18:01:23 +01:00
Larivact 2995366dde Clarify APPLICATION_ROOT #1714 2017-03-17 05:41:20 +01:00
Jan Ferko 1add1f8a02 Use print function in quickstart (#2204)
Example in URL Building section uses `print` statement
instead of `print` function, which causes syntax error
when example is run on Python 3.
2017-03-13 13:58:24 +01:00
Ben 7a5e8ef38e Fix broken link (#2202) 2017-03-08 20:26:38 +01:00
Hsiaoming Yang a7f1a21c12 Don't rely on X-Requested-With for pretty print json response (#2193)
* Don't rely on X-Requested-With for pretty print json response

* Fix test cases for pretty print json patch

* Fix gramma error in docs for pretty print json config

* Add changelog for JSONIFY_PRETTYPRINT_REGULAR
2017-03-07 10:09:46 +09:00
Static f5adb61b28 Fix typos/grammar in docs (#2201) 2017-03-06 14:05:59 +01:00
Elton Law 06112a555a Close <li> tag in tutorial (#2199)
Change was merged in the example code but wasn't changed in the docs. c54d67adee
2017-03-05 13:07:49 +01:00
Grey Li c43560777a Add tips for debug config with flask cli (#2196)
* Add tips for debug config with flask cli

`app.debug` and `app.config['DEBUG']` are not compatible with the `flask` script.

* Grammar fix

* Grammar fix
2017-03-04 11:29:04 +01:00
Sebastian Kalinowski fca5577a00 Remove extra HTML tag from fileupload docs (#2141) 2017-02-28 14:05:09 +09:00
Sergio Díaz Sánchez af11098057 Updated documentation for being able to use init_db method 2017-02-28 00:13:45 +01:00
Timothy John Perisho Eccleston dc5f48f587 Fix typo in docs/tutorial/templates.rst (#2186) 2017-02-18 07:41:58 +01:00