diff options
| author | Steve Piercy <web@stevepiercy.com> | 2016-04-16 02:39:17 -0700 |
|---|---|---|
| committer | Steve Piercy <web@stevepiercy.com> | 2016-04-16 02:39:17 -0700 |
| commit | b61a8ba298a7e474d4d209967791a0b13bc5d77d (patch) | |
| tree | 5c9338f9ca602898109bfffce7e3d642d16e8cb9 /docs/quick_tutorial/tutorial_approach.rst | |
| parent | 1220ce51e492caad3d361c9fd32dc79065b16f92 (diff) | |
| download | pyramid-b61a8ba298a7e474d4d209967791a0b13bc5d77d.tar.gz pyramid-b61a8ba298a7e474d4d209967791a0b13bc5d77d.tar.bz2 pyramid-b61a8ba298a7e474d4d209967791a0b13bc5d77d.zip | |
quick_tutorial cleanup
- replace nose and coverage with pytest and pytest-cov
- update glossary and terms
- use doscon lexer for Windows commands
- refer to Pyramid Installation and put an end to copy-pasta
- fix directory tree
Diffstat (limited to 'docs/quick_tutorial/tutorial_approach.rst')
| -rw-r--r-- | docs/quick_tutorial/tutorial_approach.rst | 66 |
1 files changed, 34 insertions, 32 deletions
diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst index 8298a4710..09e0217c6 100644 --- a/docs/quick_tutorial/tutorial_approach.rst +++ b/docs/quick_tutorial/tutorial_approach.rst @@ -2,44 +2,46 @@ Tutorial Approach ================= -This tutorial uses conventions to keep the introduction focused and -concise. Details, references, and deeper discussions are mentioned in -"See also" notes. +This tutorial uses conventions to keep the introduction focused and concise. +Details, references, and deeper discussions are mentioned in "See also" notes. .. seealso:: This is an example "See also" note. -This "Getting Started" tutorial is broken into independent steps, -starting with the smallest possible "single file WSGI app" example. -Each of these steps introduce a topic and a very small set of concepts -via working code. The steps each correspond to a directory in this -repo, where each step/topic/directory is a Python package. +This "Getting Started" tutorial is broken into independent steps, starting with +the smallest possible "single file WSGI app" example. Each of these steps +introduce a topic and a very small set of concepts via working code. The steps +each correspond to a directory in this repo, where each step/topic/directory is +a Python package. -To successfully run each step:: +To successfully run each step: - $ cd request_response - $ $VENV/bin/pip install -e . +.. code-block:: bash -...and repeat for each step you would like to work on. In most cases we -will start with the results of an earlier step. + $ cd request_response + $ $VENV/bin/pip install -e . -Directory Tree +...and repeat for each step you would like to work on. In most cases we will +start with the results of an earlier step. + +Directory tree ============== -As we develop our tutorial our directory tree will resemble the -structure below:: - - quicktutorial/ - request_response/ - development.ini - setup.py - tutorial/ - __init__.py - home.pt - tests.py - views.py - -Each of the first-level directories (e.g. ``request_response``) is a -*Python project* (except, as noted, the ``hello_world`` step.) The -``tutorial`` directory is a *Python package*. At the end of each step, -we copy a previous directory into a new directory to use as a starting -point. +As we develop our tutorial, our directory tree will resemble the structure +below: + +.. code-block:: text + + quick_tutorial + ├── env + └── request_response + ├── tutorial + │ ├── __init__.py + │ ├── tests.py + │ └── views.py + ├── development.ini + └── setup.py + +Each of the first-level directories (e.g., ``request_response``) is a *Python +project* (except as noted for the ``hello_world`` step). The``tutorial`` +directory is a *Python package*. At the end of each step, we copy a previous +directory into a new directory to use as a starting point. |
