diff options
| author | Paul Everitt <paul@agendaless.com> | 2013-08-06 10:12:42 -0400 |
|---|---|---|
| committer | Paul Everitt <paul@agendaless.com> | 2013-08-06 10:12:42 -0400 |
| commit | 71b83e5ea328b654f8463f567ecc054a55a7a90b (patch) | |
| tree | 7ba977a3592446142d5c4ea180d7b71bc2f31dbc /docs/getting_started/index.rst | |
| parent | c3e696a0cfb839c97e6c20277dc797dbd5349730 (diff) | |
| download | pyramid-71b83e5ea328b654f8463f567ecc054a55a7a90b.tar.gz pyramid-71b83e5ea328b654f8463f567ecc054a55a7a90b.tar.bz2 pyramid-71b83e5ea328b654f8463f567ecc054a55a7a90b.zip | |
Move sample code into subdirectories. Add sections for requests and views.
Diffstat (limited to 'docs/getting_started/index.rst')
| -rw-r--r-- | docs/getting_started/index.rst | 80 |
1 files changed, 12 insertions, 68 deletions
diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst index 6396a8e6c..61964056e 100644 --- a/docs/getting_started/index.rst +++ b/docs/getting_started/index.rst @@ -4,80 +4,25 @@ Getting Started With Pyramid Welcome to Pyramid, the Python web framework that lets you start small and finish big. Whether you are new to Python web development or you're -an experienced developer that wants a quick look at the major +an experienced developer wanting a quick look at the major features, this guide provides a convenient entry point with independent chapters for each topic. -:doc:`quick_glance` -=================== - -Python web development is a very big topic. Wouldn't it be great to -have a quick overview, end-to-end, just to get oriented? This chapter -shows "a little about a lot", full of short code snippets and links to -deeper treatment of topics. Additionally, we showcase some facilities -that make Pyramid unique for "applications with ambition." - -:doc:`about_guide` -================== - -Now that we have set the scene, we explain the purpose of this guide -(and non-purpose), showing how it is organized. - - -:doc:`scaffolds` +About This Guide ================ -Pyramid projects are organized using normal Python facilities for -projects. Normal, though, is in the eye of the beholder. This chapter -shows how to use scaffolds to automate the boilerplate and quickly -start development of a new project. - -Topics: scaffolds, packaging, virtual environments - -:doc:`configuration` -==================== - - -:doc:`routes` -============= - -:doc:`views` -============ - -:doc:`templates` -================ - -:doc:`static_assets` -==================== - -:doc:`testing` -============== - -:doc:`forms` -============ - -:doc:`databases` -================ - -:doc:`security` -=============== - -:doc:`json` -=========== - - -:doc:`sessions` -=============== - -:doc:`internationalization` -=========================== - +Evaluators want to jump right into a particular topic. This *Getting +Started* guide is structured with chapter titles that focuses on a +particular aspect of web development. Each chapter is autonomous and +you don't have to follow from beginning to end. -:doc:`special_views` -==================== +By definition, each topic is covered at a high level. To make it easy +to get to in-depth treatment, the chapters provide interlinking with +the full treatment in the :ref:`html_narrative_documentation`. -:doc:`top_ten` -============== +This guide is part of the official documentation. If you find a bug, +you can report it using the same facilities as the described in the +software's :ref:`support-and-development`. Contents ======== @@ -86,7 +31,6 @@ Contents :maxdepth: 2 quick_glance - about_guide scaffolds configuration routes |
