Commit Graph

138 Commits

Author SHA1 Message Date
Dave Morse 50c6df7098 Minor edits to tutorial for clarity. (#2330) 2017-05-24 17:00:20 -07: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
Timothy John Perisho Eccleston dc5f48f587 Fix typo in docs/tutorial/templates.rst (#2186) 2017-02-18 07:41:58 +01:00
Jeff Widman bb0e755c80 Migrate various docs links to https (#2180)
Also fixed a few outdated links
2017-02-11 10:43:11 +01:00
vojtekb 95db82f8f7 py.test => pytest (#2173)
py.test => pytest
2017-02-09 18:34:16 +01:00
Markus Unterwaditzer 2b8fef4fe7 Merge branch '0.11-maintenance' 2016-10-30 14:35:15 +01:00
Kyle Lawlor fa087c8929 Fixes import statement in flaskr (#2068)
- `from flaskr.flaskr import app` in flaskr/__init__.py
  causes an import error with Python 2
- The relative import now used works for py2 and py3
2016-10-30 14:34:49 +01:00
Markus Unterwaditzer 7132feb1a5 Merge branch '0.11-maintenance' 2016-09-08 15:21:05 +02:00
Kyle Lawlor e6f9d2b414 Clean up tutorial docs for installable app pattern with flaskr (#2002)
* Clean up tutorial docs for installable app pattern

- reading sequentially through the tutorial works.
- fixes references to `export FLASK_APP=flaskr.flaskr`

* Fixes titles for each section of flaskr tutorial

* Revert grammar

* Emphasize the Packaging Guide

- adds more general packaging resource
- removes the emphasis put on setuptools

* rephrase and remove note admonitions

- expanded on few points
- removed note blocks, they are unneccessary

* Remove note about reinstalling to update cli

- I had mistakenly thought it was necessary to
  re-install the app to update the cli.
- the `--editable` flag detects the change and
  the cli updates without issue.
2016-09-08 15:19:48 +02:00
Josh Soref 6e6c3a4636 Spelling (#1998)
* spelling: cacheability

* spelling: conceptually

* spelling: javascript

* spelling: reset

* spelling: raised

* comma: instead..., they...
2016-08-30 00:26:20 +02:00
SaturnR 55bd39c7f0 Update for python3 (#1973)
just updated print 'Initialized the database.' with print('Initialized the database.') to be python3 compliant
2016-08-20 17:43:10 +02:00
Kyle Lawlor 17d4cb3828 Address #1902: Converts example/flaskr to have a setup.py (#1945)
* Converts example/flaskr to have a setup.py

Makes the flaskr app easier to run, ex. workflow:
- pip install --editable .
- export FLASK_APP=flaskr.flaskr
- flask initdb
- flask run

Testing is also easier now:
- python setup.py test

* Fixed an import error in flaskr/tests

- the statement `import flaskr` caused errors in python3
- `from . import flaskr` fixes the issue in 2.7.11 and 3.5.1

* Better project structure and updates the docs

- Re-factors *flaskr*'s project structure a bit
- Updates docs to make sense with the new structure
  - Adds a new step about installing Flask apps with setuptools
  - Switches first-person style writing to second-person (reads better IMO)
  - Adds segments in *testing.rst* for running tests with setuptools

* Remove __init__.py from tests

- py.test recommends not using __init__.py

* Fix testing import errors
2016-07-05 17:30:59 -07:00
Armin Ronacher a7d829c618 Update docs to the new CLI patterns 2016-05-26 20:45:50 +02:00
Winston Kouch 594d1c5eb2 Add note to not use plain text passwords to views.rst 2016-04-05 18:53:08 +02:00
José Carlos García 567fff9d0d Change to Pallets project
* Update CHANGES

* Update CONTRIBUTING.rst

* Update setup.py

* Update tox.ini

* Update extensions.rst

* Update security.rst

* Update installation.rst

* Update testing.rst

* Update upgrading.rst

* Update sidebarintro.html

* Update jquery.rst

* Update dbcon.rst

* Update index.rst
2016-04-03 23:11:38 +02:00
bagratte 9a80fe691d minor revision of documentation. 2016-04-01 23:12:25 +02:00
Austen D'Souza fc0e1a8d8a Fixed typo
I think it's supposed to be an upper-case 'F'. Cheers :)
2016-03-23 02:02:04 +05:30
Alex Chan 8570633214 Fix a few spelling mistakes in the docs 2015-04-03 20:43:40 +01:00
Kevin Yap 23fc2e56a8 Grammatical fixes in Foreword and Tutorial 2014-12-16 11:30:00 -08:00
defuz d338dc8a13 docs: ``.html``, ``.py`` 2014-11-05 07:52:04 +03:00
defuz 663802e976 docs: ``with``, ``for``, ``self`` 2014-11-05 07:39:54 +03:00
defuz 02694d609f docs: :command:`pip`, :option:`--debug` 2014-11-05 07:03:55 +03:00
defuz a8f570cc62 docs: :file:`app.py`, :file:`yourapp/templates` 2014-11-05 06:45:22 +03:00
defuz 3fa4fd0908 docs: http method names like ``GET`` and ``POST`` 2014-11-05 06:13:01 +03:00
defuz 8284217593 docs: ``True``, ``False`` and ``None`` 2014-11-05 06:04:58 +03:00
defuz 6dbb015b43 docs: `HTTP` -> HTTP 2014-11-05 05:56:02 +03:00
Petr Zemek 3159c86166 Unify the uses of "sourcecode" vs "source code".
Use "source code", which is more grammatically correct.
2014-10-27 11:54:28 +01:00
Daniel Neuhäuser f6618c7638 Merge pull request #1099 from root-11/patch-1
Update schema.rst
2014-07-27 13:31:59 +02:00
Nico Revin 22219f51e5 Update doclinks
Fix redirects and broken links
2014-07-24 23:30:50 +04:00
root-11 2d992e7f13 Update schema.rst
The error is that sqlite3 needs escaping on the database column 'text' in the line:
text text not null
so that it becomes:
'text' text not null

The example on mitsuhiko/flask is correct and helped me detecting the mistake.
2014-07-01 15:57:50 +01:00
Kenneth Reitz 0ce47a365f Merge pull request #1096 from slater/patch-1
Update dbcon.rst
2014-06-30 19:42:32 -04:00
Mark Slater 35282a881e Update dbinit.rst
"require" -> "requires"
2014-06-29 15:51:03 -07:00
Mark Slater 171253a0eb Update dbcon.rst
"Teared" should be "torn", I think?
2014-06-29 15:48:52 -07:00
lord63 2b8a281c1c fix a small mistake in setup.rst 2014-05-12 16:01:53 +08:00
lord63 4a6f932610 fix a small mistake in setup.rst 2014-05-11 14:08:35 +08:00
Armin Ronacher b9013ede22 Clarified how to test with click 2014-05-02 11:50:00 +01:00
Armin Ronacher a3a5075a94 Updated tutorial to the flask script 2014-04-28 15:18:27 +02:00
Daniel Neuhäuser ea73571a54 Merge pull request #1032 from cgar/spelling
few mispelling errors
2014-04-26 02:12:51 +02:00
Daniel Neuhäuser 954eeb8d17 Fix Jinja link 2014-04-26 01:26:12 +02:00
Daniel Neuhäuser 20edb3189c Fix Pocoo documentation links 2014-04-26 01:20:12 +02:00
Carlos E. Garcia 52fa195d45 few mispelling errors 2014-04-23 10:46:38 -04:00
Armin Ronacher 95fa9f21ec Added a missing import 2014-03-19 23:07:42 +00:00
Armin Ronacher a8a98bc6b6 Various documentation fixups 2014-02-08 22:10:08 +00:00
Armin Ronacher 9074bc46af Switch away from /tmp for windows users 2014-02-08 22:07:13 +00:00
Armin Ronacher afd3c4532b Rewrapped lines 2013-11-09 13:41:09 +00:00
Reetta Vaahtoranta 0d648fa468 Changed the wording of some sentences there were difficult to understand. 2013-11-09 13:13:14 +00:00
talam b7f21831fa Updated some typos
Fixed some incorrect variable references.
2013-10-12 18:14:26 -04:00
Sean Vieira 12d6ec4130 Fix with block 2013-09-03 23:36:10 -04:00
Armin Ronacher 05161d3584 Rewrote tutorial to use the g based appcontext object 2013-09-01 01:32:41 +06:00
Armin Ronacher 1982c208ce Merge pull request #808 from untitaker/issue782
Fix #782 -- /tmp/ in tutorial
2013-07-26 16:28:08 -07:00
Markus Unterwaditzer fd9bf8f376 Fix #782 -- /tmp/ in tutorial 2013-07-27 01:21:01 +02:00
Nick Zaccardi 5ace060e5e cleared up confusion for from_envvar 2013-07-22 09:03:57 -05:00
Armin Ronacher 2c9c269284 Fixed a broken reference 2013-06-09 12:32:12 +01:00
Armin Ronacher 29bda590b2 Modernized docs in a few places 2013-06-09 12:30:27 +01:00
Thomas Waldmann 8bb972e5ae fix minitwit/flaskr test errors, improve docs about file open mode
app.open_resource needs to get called with the correct mode param (python3
will read bytes [not str] if the wrong mode is used), add mode param docs.

rv.data is bytes, fix the data type we compare it with to be also bytes
2013-05-25 19:13:48 +02:00
Thomas Waldmann 40fad2ece8 document python 2.6 minimum requirement, remove all stuff that refers to 2.5 2013-05-18 17:06:25 +02:00
OrangeTux cc5d6134c7 Update css.rst
Improved consistency: lower cased all hexadecimal descriptions of colors.
2013-02-28 11:12:16 +01:00
oliversong cc82feb084 Changing string to text in schema files 2012-12-26 00:05:18 -05:00
Markus Unterwaditzer 7ee40e9348 Fix #611
Minor but confusing typo in tutorial.
2012-10-16 21:56:51 +02:00
Ron DuPlain ea2a0629c9 Touch up dbinit tutorial doc.
Discussion on #pocoo with svenstaro, dAnjou, noob13.
2012-07-04 15:27:15 -04:00
Sven-Hendrik Haase 690b0c34ff Fix chose -> choose typo 2012-07-04 21:19:41 +02:00
Sven-Hendrik Haase 0553bbdefe Made it explicitly clear where changes should go in the tutorial 2012-07-04 21:12:41 +02:00
Kevin Burke 6b9e6a5a52 add heroku/deploy options to quickstart, and add more clear links in tutorial setup. 2012-03-11 20:20:32 -07:00
Ron DuPlain c240a1f781 Add code organization help to tutorial doc.
As suggested by burhan on #pocoo today.
2011-07-26 16:32:36 -04:00
consigliere 1a249e3389 Corrected decorators to remove duplicate teardown_request() and add after_request() 2011-07-11 15:28:11 -07:00
Bastian Hoyer d63fb818c1 small error in tutorial 2011-07-06 16:07:05 +02:00
Armin Ronacher 22d468e190 Less annoying gender neutral forms 2011-06-28 14:34:07 +02:00
Armin Ronacher 4e47ea9105 Merge branch 'master' into blueprints 2011-06-27 09:30:39 +02:00
Jeffrey Finkelstein 12761bd02c fixed pronoun gender in documentation 2011-06-26 21:43:48 -04:00
Armin Ronacher a9fc040c39 Updated documentation to use teardown request where appropriate 2011-05-27 20:21:41 +02:00
Kanak Kshetri 0e4cd2e651 Fixed a typo that was preventing second code block from appearing in a code block
Signed-off-by: Armin Ronacher <armin.ronacher@active-4.com>
2011-04-18 16:40:51 +02:00
Noufal Ibrahim a2225bf57e Added a note on actually starting the application
Signed-off-by: Armin Ronacher <armin.ronacher@active-4.com>
2011-04-18 16:32:13 +02:00
Matt Chisholm 04e70bd5c7 Add teardown_request decorator. Fixes issue #174 2011-03-14 14:28:15 -04:00
Daniel Haaker ce4f81f1c2 Correct capitalization SQLite
Signed-off-by: Armin Ronacher <armin.ronacher@active-4.com>
2010-10-29 18:41:21 +02:00
Daniel Haaker d8f521e1ff Add missing period
Signed-off-by: Armin Ronacher <armin.ronacher@active-4.com>
2010-10-29 18:41:17 +02:00
Nick Walker 1f6321a1cb clarified description of templates directory
Signed-off-by: Armin Ronacher <armin.ronacher@active-4.com>
2010-10-22 15:37:50 +03:00
Ron DuPlain 6875a057ec Fixed small typos in docs. Added a cross-ref. 2010-10-07 19:32:07 +08:00
Armin Ronacher 63114529ed good -> bad 2010-07-23 17:49:03 +01:00
Ron DuPlain b4b2f42f48 Warn about SQL injection in the tutorial. 2010-07-16 04:57:18 +08:00
Adam Zapletal 5ede53066f Minor tutorial documentation fixes (grammar, etc) 2010-06-28 15:12:32 +08:00
Georg Brandl a224fecfd5 More typo fixes. 2010-05-30 02:15:05 +08:00
Armin Ronacher dfecc86dd3 Ported examples over to new config. documented upgrading 2010-05-27 21:17:25 +02:00
Armin Ronacher 9d19b77acf Added lazyloading pattern and explicit chapter links in tutorial.
This fixes #49.
2010-05-26 14:49:01 +02:00
Armin Ronacher a9284afde9 Fixed typo in tutorial. This fixes #19 2010-05-02 11:38:40 +02:00
Armin Ronacher ef34638f5d Updated docs for external server information.
This fixes #14.
2010-04-24 17:46:06 +02:00
Armin Ronacher 84899948be Corrected order of the tutorial 2010-04-19 02:45:44 +02:00
Armin Ronacher 100776147a Added troubleshooting section to the tutorial 2010-04-18 18:40:52 +02:00
Armin Ronacher bcf347fe8d New style for the documentation. Looks more like the website now. 2010-04-18 13:15:00 +02:00