Commit Graph

21 Commits

Author SHA1 Message Date
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
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
Kevin Yap 23fc2e56a8 Grammatical fixes in Foreword and Tutorial 2014-12-16 11:30:00 -08:00
defuz 8284217593 docs: ``True``, ``False`` and ``None`` 2014-11-05 06:04:58 +03:00
Nico Revin 22219f51e5 Update doclinks
Fix redirects and broken links
2014-07-24 23:30:50 +04:00
Mark Slater 171253a0eb Update dbcon.rst
"Teared" should be "torn", I think?
2014-06-29 15:48:52 -07:00
Carlos E. Garcia 52fa195d45 few mispelling errors 2014-04-23 10:46:38 -04:00
talam b7f21831fa Updated some typos
Fixed some incorrect variable references.
2013-10-12 18:14:26 -04:00
Armin Ronacher 05161d3584 Rewrote tutorial to use the g based appcontext object 2013-09-01 01:32:41 +06: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
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 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
Matt Chisholm 04e70bd5c7 Add teardown_request decorator. Fixes issue #174 2011-03-14 14:28:15 -04: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 bcf347fe8d New style for the documentation. Looks more like the website now. 2010-04-18 13:15:00 +02:00