Commit Graph

28 Commits

Author SHA1 Message Date
Dave Morse 50c6df7098 Minor edits to tutorial for clarity. (#2330) 2017-05-24 17:00:20 -07: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
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
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 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
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 a3a5075a94 Updated tutorial to the flask script 2014-04-28 15:18:27 +02:00
Armin Ronacher 95fa9f21ec Added a missing import 2014-03-19 23:07:42 +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
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
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
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
Daniel Haaker d8f521e1ff Add missing period
Signed-off-by: Armin Ronacher <armin.ronacher@active-4.com>
2010-10-29 18:41:17 +02:00
Ron DuPlain 6875a057ec Fixed small typos in docs. Added a cross-ref. 2010-10-07 19:32:07 +08:00
Adam Zapletal 5ede53066f Minor tutorial documentation fixes (grammar, etc) 2010-06-28 15:12:32 +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 ef34638f5d Updated docs for external server information.
This fixes #14.
2010-04-24 17:46:06 +02:00
Armin Ronacher bcf347fe8d New style for the documentation. Looks more like the website now. 2010-04-18 13:15:00 +02:00