From ae4c577d12a16396b45515e81415b2b16f8e93e8 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 13 Jul 2011 20:48:38 -0400 Subject: move all paster commands to a separate chapter --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index a4743af9b..2beec2494 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -59,6 +59,7 @@ Narrative documentation in chapter form explaining how to use narr/vhosting narr/events narr/environment + narr/commandline narr/testing narr/hooks narr/advconfig -- cgit v1.2.3 From 2ce6659c9c3f0cd916cb85f43bd973a53d857a14 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 16 Jul 2011 23:11:18 -0400 Subject: ordering --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 2beec2494..9b5c24a20 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -24,8 +24,8 @@ Front Matter .. toctree:: :maxdepth: 1 - whatsnew-1.0 whatsnew-1.1 + whatsnew-1.0 Narrative documentation ======================= -- cgit v1.2.3 From 8cb68208d42899b50025418812bb339f578d553f Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 20 Jul 2011 07:16:14 -0400 Subject: - Reordered chapters in narrative section for better new user friendliness. - Added more indexing markers to sections in documentation. --- docs/index.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 9b5c24a20..85e733dc3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -43,24 +43,24 @@ Narrative documentation in chapter form explaining how to use narr/project narr/startup narr/urldispatch - narr/muchadoabouttraversal - narr/traversal narr/views narr/renderers narr/templates narr/viewconfig - narr/resources narr/assets narr/webob narr/sessions - narr/security - narr/hybrid - narr/i18n - narr/vhosting narr/events narr/environment narr/commandline + narr/i18n + narr/vhosting narr/testing + narr/resources + narr/muchadoabouttraversal + narr/traversal + narr/security + narr/hybrid narr/hooks narr/advconfig narr/extending -- cgit v1.2.3 From 1ae7af86d5d4898788ff64b46e887a06c47e69ea Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 13 Aug 2011 01:43:21 -0400 Subject: - Added a Logging chapter to the narrative docs (based on the Pylons logging docs, thanks Phil). --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 85e733dc3..8ffc7b4fe 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -52,6 +52,7 @@ Narrative documentation in chapter form explaining how to use narr/sessions narr/events narr/environment + narr/logging narr/commandline narr/i18n narr/vhosting -- cgit v1.2.3 From a8c81dbd55b1e06dd2da1b598670dc27a73ce8b1 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 21 Aug 2011 00:23:00 -0400 Subject: add a whatsnew-1.2 doc --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 8ffc7b4fe..0c8b44e76 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -24,6 +24,7 @@ Front Matter .. toctree:: :maxdepth: 1 + whatsnew-1.2 whatsnew-1.1 whatsnew-1.0 -- cgit v1.2.3 From 3d338ea5737b7c113b17120b40684e2694cf3fa9 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 22 Aug 2011 02:16:55 -0400 Subject: - Use [app:main] instead of a pipeline in all scaffolds and tutorials and narrative docs. - Break out awkward description of PasteDeploy entry points from project chapter into its own Paste chapter. --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 0c8b44e76..380dce065 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,6 +54,7 @@ Narrative documentation in chapter form explaining how to use narr/events narr/environment narr/logging + narr/paste narr/commandline narr/i18n narr/vhosting -- cgit v1.2.3 From d36b566a83addddb80d221aa042b828268f185f2 Mon Sep 17 00:00:00 2001 From: Dylan Jay Date: Thu, 25 Aug 2011 13:05:52 +1000 Subject: use routes in firstapp as they are more familar to most and put hello world on the front page to make grab framework shoppers attention. --- docs/index.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 380dce065..0acf24b5a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,6 +9,29 @@ development framework. It is developed as part of the `Pylons Project `_. It is licensed under a `BSD-like license `_. +Here is one of the simplest :app:`Pyramid` applications you can make. + +.. code-block:: python + + from paste.httpserver import serve + from pyramid.configuration import Configurator + + def hello_world(request): + return 'Hello %(name)s!' % request.matchdict + + if __name__ == '__main__': + config = Configurator() + config.add_route('hello', '/hello/{name}') + config.add_view(hello_world, route_name='hello') + app = config.make_wsgi_app() + serve(app, host='0.0.0.0') + +See :ref:`firstapp_chapter` for a full explanation of how this :ref:`helloworld_imperative` +app works. Read the :ref:`narrative_documentation` to understand how :app:`Pyramid` is designed +to scale from these simple beginnings to handle the largest of web application needs. If your +familiar with other web frameworks you might want to look at :ref:`design_defense` to understand +why :app:`Pyramid` has been designed the way it has. + Front Matter ============ @@ -28,6 +51,8 @@ Front Matter whatsnew-1.1 whatsnew-1.0 +.. _narrative_documentation: + Narrative documentation ======================= -- cgit v1.2.3 From a98c0169fad222654e0c2ba0573653002a21d29b Mon Sep 17 00:00:00 2001 From: Dylan Jay Date: Thu, 25 Aug 2011 13:10:43 +1000 Subject: include rather than repeat helloworld.py --- docs/index.rst | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 0acf24b5a..70cf4cabf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,20 +11,7 @@ development framework. It is developed as part of the `Pylons Project Here is one of the simplest :app:`Pyramid` applications you can make. -.. code-block:: python - - from paste.httpserver import serve - from pyramid.configuration import Configurator - - def hello_world(request): - return 'Hello %(name)s!' % request.matchdict - - if __name__ == '__main__': - config = Configurator() - config.add_route('hello', '/hello/{name}') - config.add_view(hello_world, route_name='hello') - app = config.make_wsgi_app() - serve(app, host='0.0.0.0') +.. literalinclude:: narr/helloworld.py See :ref:`firstapp_chapter` for a full explanation of how this :ref:`helloworld_imperative` app works. Read the :ref:`narrative_documentation` to understand how :app:`Pyramid` is designed -- cgit v1.2.3 From d73be153fa9544f453510524f34d55a7602e0896 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 25 Aug 2011 02:23:51 -0400 Subject: use Response; fix text --- docs/index.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 70cf4cabf..3d66be648 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,11 +13,11 @@ Here is one of the simplest :app:`Pyramid` applications you can make. .. literalinclude:: narr/helloworld.py -See :ref:`firstapp_chapter` for a full explanation of how this :ref:`helloworld_imperative` -app works. Read the :ref:`narrative_documentation` to understand how :app:`Pyramid` is designed -to scale from these simple beginnings to handle the largest of web application needs. If your -familiar with other web frameworks you might want to look at :ref:`design_defense` to understand -why :app:`Pyramid` has been designed the way it has. +See :ref:`firstapp_chapter` for a full explanation of how this +:ref:`helloworld_imperative` app works. Read the +:ref:`narrative_documentation` to understand how :app:`Pyramid` is designed +to scale from these simple beginnings to handle the largest of web +application needs. Front Matter ============ -- cgit v1.2.3 From 55860e65544713c4dfb000c4e516cdd7157c1040 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 25 Aug 2011 05:45:56 -0400 Subject: dont use duplicate target --- docs/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 3d66be648..869432927 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,8 +15,8 @@ Here is one of the simplest :app:`Pyramid` applications you can make. See :ref:`firstapp_chapter` for a full explanation of how this :ref:`helloworld_imperative` app works. Read the -:ref:`narrative_documentation` to understand how :app:`Pyramid` is designed -to scale from these simple beginnings to handle the largest of web +:ref:`html_narrative_documentation` to understand how :app:`Pyramid` is +designed to scale from these simple beginnings to handle the largest of web application needs. Front Matter @@ -38,7 +38,7 @@ Front Matter whatsnew-1.1 whatsnew-1.0 -.. _narrative_documentation: +.. _html_narrative_documentation: Narrative documentation ======================= -- cgit v1.2.3 From e17da6c60f03a2eaceee4d2ab9e9b06dd875d3d0 Mon Sep 17 00:00:00 2001 From: Dylan Jay Date: Fri, 26 Aug 2011 14:36:00 +1000 Subject: include install and move firstapp higher up index --- docs/index.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 3d66be648..e4a637b57 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,15 @@ Here is one of the simplest :app:`Pyramid` applications you can make. .. literalinclude:: narr/helloworld.py +Which when saved to ``helloworld.py`` can be run by + +.. code-block:: text + + $ easy_install pyramid + $ python helloworld.py + serving on 0.0.0.0:8080 view at http://127.0.0.1:8080 + + See :ref:`firstapp_chapter` for a full explanation of how this :ref:`helloworld_imperative` app works. Read the :ref:`narrative_documentation` to understand how :app:`Pyramid` is designed @@ -51,8 +60,8 @@ Narrative documentation in chapter form explaining how to use narr/introduction narr/install - narr/configuration narr/firstapp + narr/configuration narr/project narr/startup narr/urldispatch -- cgit v1.2.3 From d4bbb679ad7e0cba89fabb321a4477ba8b165586 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 27 Aug 2011 04:14:22 -0400 Subject: reword --- docs/index.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 601c075fb..de1848506 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,11 +9,11 @@ development framework. It is developed as part of the `Pylons Project `_. It is licensed under a `BSD-like license `_. -Here is one of the simplest :app:`Pyramid` applications you can make. +Here is one of the simplest :app:`Pyramid` applications you can make: .. literalinclude:: narr/helloworld.py -Which when saved to ``helloworld.py`` can be run by +When saved to ``helloworld.py``, the above application can be run via: .. code-block:: text @@ -22,11 +22,10 @@ Which when saved to ``helloworld.py`` can be run by serving on 0.0.0.0:8080 view at http://127.0.0.1:8080 -See :ref:`firstapp_chapter` for a full explanation of how this -:ref:`helloworld_imperative` app works. Read the -:ref:`html_narrative_documentation` to understand how :app:`Pyramid` is -designed to scale from these simple beginnings to handle the largest of web -application needs. +See :ref:`firstapp_chapter` for a full explanation of how this application +works. Read the :ref:`html_narrative_documentation` to understand how +:app:`Pyramid` is designed to scale from simple beginnings like this to the +largest of web applications. Front Matter ============ -- cgit v1.2.3 From 5ab0f33f5d6799700491dbe5b18c563cc5e51a3c Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 27 Aug 2011 13:52:41 -0400 Subject: reword --- docs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index de1848506..f17c6c921 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -24,8 +24,8 @@ When saved to ``helloworld.py``, the above application can be run via: See :ref:`firstapp_chapter` for a full explanation of how this application works. Read the :ref:`html_narrative_documentation` to understand how -:app:`Pyramid` is designed to scale from simple beginnings like this to the -largest of web applications. +:app:`Pyramid` is designed to scale from simple applications like this to +very large web applications. Front Matter ============ -- cgit v1.2.3 From d3c67e469eb45fc72a05da66fecf8a90a370293a Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 27 Aug 2011 14:49:18 -0400 Subject: describe output --- docs/index.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index f17c6c921..579bea337 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,6 +21,8 @@ When saved to ``helloworld.py``, the above application can be run via: $ python helloworld.py serving on 0.0.0.0:8080 view at http://127.0.0.1:8080 +And when you visit ``http://localhost:8080/hello/world`` in a browser, you +will see the text ``Hello, world!``. See :ref:`firstapp_chapter` for a full explanation of how this application works. Read the :ref:`html_narrative_documentation` to understand how -- cgit v1.2.3 From 7ced0a4d75954d9cc23bd47b70c70598beadf1b4 Mon Sep 17 00:00:00 2001 From: Michael Date: Thu, 8 Sep 2011 02:02:31 -0700 Subject: mention #pyramid irc channel --- docs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 579bea337..d7f2f4fb6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -206,8 +206,8 @@ To report bugs, use the `issue tracker If you've got questions that aren't answered by this documentation, contact the `Pylons-devel maillist -`_ or join the `#pylons -IRC channel `_. +`_ or join the `#pyramid +IRC channel `_. Browse and check out tagged and trunk versions of :app:`Pyramid` via the `Pyramid GitHub repository `_. -- cgit v1.2.3 From 012b9762cd0b114b6afbf2d6356554b51706804a Mon Sep 17 00:00:00 2001 From: michr Date: Fri, 23 Sep 2011 18:48:28 -0700 Subject: fixed up all the warning dealing ..note and ..warn added a hide toc for glossary to prevent warnings --- docs/index.rst | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index d7f2f4fb6..25aaab7af 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -227,3 +227,12 @@ Index and Glossary * :ref:`glossary` * :ref:`genindex` * :ref:`search` + + +.. add glossary in hidden toc tree so it does not complain its not included + +.. toctree:: + :hidden: + + glossary + -- cgit v1.2.3 From c8b363e547635e92a78c5718e9f17a5e8f55dc7f Mon Sep 17 00:00:00 2001 From: michr Date: Thu, 29 Sep 2011 02:03:33 -0700 Subject: avoid warning for latexindex, foreword by putting them in a hidden toc from now on complie docs strictly, turning warnings to errors exclude unnecssary static js files when compiling ePub --- docs/index.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 25aaab7af..e4de8b0c8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -229,10 +229,12 @@ Index and Glossary * :ref:`search` -.. add glossary in hidden toc tree so it does not complain its not included +.. add glossary, foreword, and latexindex in a hidden toc to avoid warnings .. toctree:: :hidden: glossary + foreword.rst + latexindex.rst -- cgit v1.2.3 From c4503bf117e43f780c269e64edbde71fc3d6d72b Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 3 Dec 2011 01:56:17 -0500 Subject: break out 'extending config' into exconfig and add stuff about the action method; move startup and router chapters to earlier in toc --- docs/index.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index e4de8b0c8..f07e8eac2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -65,6 +65,7 @@ Narrative documentation in chapter form explaining how to use narr/configuration narr/project narr/startup + narr/router narr/urldispatch narr/views narr/renderers @@ -87,9 +88,9 @@ Narrative documentation in chapter form explaining how to use narr/security narr/hybrid narr/hooks - narr/advconfig narr/extending - narr/router + narr/advconfig + narr/extconfig narr/threadlocals narr/zca -- cgit v1.2.3 From 9d97b654057e621c4928fe597053d54aa5f63a8c Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 3 Dec 2011 03:00:15 -0500 Subject: add skeleton for using introspection chapter --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index f07e8eac2..ceb29d108 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -88,6 +88,7 @@ Narrative documentation in chapter form explaining how to use narr/security narr/hybrid narr/hooks + narr/introspector narr/extending narr/advconfig narr/extconfig -- cgit v1.2.3 From d83b3943474d2eb01b0fd8c1be31c50553fd4384 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 5 Dec 2011 01:41:04 -0500 Subject: add whatsnew-1.3; garden --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index ceb29d108..df7a422d4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -44,6 +44,7 @@ Front Matter .. toctree:: :maxdepth: 1 + whatsnew-1.3 whatsnew-1.2 whatsnew-1.1 whatsnew-1.0 -- cgit v1.2.3 From bfd4b39b3467681ad34b1dda74acd20294e81a86 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 14 Dec 2011 09:10:10 -0500 Subject: - Changed scaffolding machinery around a bit to make it easier for people who want to have extension scaffolds that can work across Pyramid 1.0.X, 1.1.X, 1.2.X and 1.3.X. See the new "Creating Pyramid Scaffolds" chapter in the narrative documentation for more info. - Added an API docs chapter for ``pyramid.scaffolds``. - Added a narrative docs chapter named "Creating Pyramid Scaffolds". - The ``template_renderer`` method of ``pyramid.scaffolds.PyramidScaffold`` was renamed to ``render_template``. If you were overriding it, you're a bad person, because it wasn't an API before now. But we're nice so we're letting you know. --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index df7a422d4..ca5f4aa30 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -93,6 +93,7 @@ Narrative documentation in chapter form explaining how to use narr/extending narr/advconfig narr/extconfig + narr/scaffolding narr/threadlocals narr/zca -- cgit v1.2.3 From 4288cbb755941537a02fff35004309fc13c912dc Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 15 Dec 2011 14:59:14 -0500 Subject: we now use wsgiref which prints nothing --- docs/index.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index ca5f4aa30..21e587992 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,10 +19,9 @@ When saved to ``helloworld.py``, the above application can be run via: $ easy_install pyramid $ python helloworld.py - serving on 0.0.0.0:8080 view at http://127.0.0.1:8080 -And when you visit ``http://localhost:8080/hello/world`` in a browser, you -will see the text ``Hello, world!``. +When you visit ``http://localhost:8080/hello/world`` in a browser, you will +see the text ``Hello, world!``. See :ref:`firstapp_chapter` for a full explanation of how this application works. Read the :ref:`html_narrative_documentation` to understand how -- cgit v1.2.3 From 9003a8bba654f98933b98dacac67760cff73e1c5 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 16 Dec 2011 04:35:05 -0500 Subject: - Removed the "Running Pyramid on Google App Engine" tutorial from the main docs. It survives on in the Cookbook (http://docs.pylonsproject.org/projects/pyramid_cookbook/en/latest/gae.html). Rationale: it provides the correct info for the Python 2.5 version of GAE only, and this version of Pyramid does not support Python 2.5. --- docs/index.rst | 1 - 1 file changed, 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 21e587992..be03448c9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -109,7 +109,6 @@ applications to various platforms. tutorials/wiki2/index.rst tutorials/wiki/index.rst tutorials/bfg/index.rst - tutorials/gae/index.rst tutorials/modwsgi/index.rst Reference Material -- cgit v1.2.3 From 97b64d3b736f6abf0d78126c75d5e56e774bd234 Mon Sep 17 00:00:00 2001 From: Paul Winkler Date: Mon, 30 Jan 2012 17:34:51 -0500 Subject: Hello world with traversal, linked from various places; plus some 'what this chapter is for' notes on the other traversal chapters. Hope this helps. --- docs/index.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index be03448c9..cb632d5b2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -83,6 +83,7 @@ Narrative documentation in chapter form explaining how to use narr/vhosting narr/testing narr/resources + narr/hellotraversal narr/muchadoabouttraversal narr/traversal narr/security @@ -152,7 +153,8 @@ application. Check this application out via: `virginia `_ is a very simple dynamic file rendering application. It is willing to render structured text -documents, HTML documents, and images from a filesystem directory. An +documents, HTML documents, and images from a filesystem directory. +It's also a good example of :term:`traversal`. An earlier version of this application runs the `repoze.org `_ website. Check this application out via: -- cgit v1.2.3 From aebd2fd83fca7dcb13d351bbcbfa40f3e22633c3 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 4 Mar 2012 13:06:45 -0500 Subject: garden titles of index --- docs/index.rst | 52 ++++++++++++++++------------------------------------ 1 file changed, 16 insertions(+), 36 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index cb632d5b2..ba71d5fff 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,8 +37,8 @@ Front Matter copyright.rst conventions.rst -"What's New" Documents -====================== +What's New +========== .. toctree:: :maxdepth: 1 @@ -100,9 +100,9 @@ Narrative documentation in chapter form explaining how to use Tutorials ========= -Detailed tutorials explaining how to use :app:`Pyramid` to build -various types of applications and how to deploy :app:`Pyramid` -applications to various platforms. +Tutorials explaining how to use :app:`Pyramid` to build various types of +applications, and how to deploy :app:`Pyramid` applications to various +platforms. .. toctree:: :maxdepth: 2 @@ -112,26 +112,26 @@ applications to various platforms. tutorials/bfg/index.rst tutorials/modwsgi/index.rst -Reference Material +API Documentation ================== -Reference material includes documentation for every :app:`Pyramid` API. +Documentation for every :app:`Pyramid` API. .. toctree:: :maxdepth: 2 api -Detailed Change History -======================= +Change History +============== .. toctree:: :maxdepth: 1 changes -Design Documentation -==================== +Design Documents +================ .. toctree:: :maxdepth: 1 @@ -172,31 +172,11 @@ Check this application out of version control via: git clone git://github.com/Pylons/shootout.git -Older Sample Applications (repoze.bfg) -====================================== - -.. note:: - - These applications are for an older version of :app:`Pyramid`, which was - named :mod:`repoze.bfg`. They won't work unmodified under Pyramid, but - might provide useful clues. - -`bfgsite `_ is the software which -runs the `bfg.repoze.org `_ website. It -demonstrates integration with Trac, and includes several -mini-applications such as a pastebin and tutorial engine. Check a -buildout for this application out of Subversion via: - -.. code-block:: text - - svn co http://svn.repoze.org/buildouts/bfgsite/ bfgsite_buildout - -`KARL `_ is a moderately-sized application -(roughly 70K lines of Python code) built on top of :mod:`repoze.bfg` -and other Repoze software. It is an open source web system for -collaboration, organizational intranets, and knowledge management, It -provides facilities for wikis, calendars, manuals, searching, tagging, -commenting, and file uploads. See the `KARL site +`KARL `_ is a moderately-sized application (roughly +80K lines of Python code) built on top of :app:`Pyramid`. It is an open +source web system for collaboration, organizational intranets, and knowledge +management, It provides facilities for wikis, calendars, manuals, searching, +tagging, commenting, and file uploads. See the `KARL site `_ for download and installation details. Support and Development -- cgit v1.2.3 From 59a38c68a94f3437f632811c36366f3b60aee9d0 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 4 Mar 2012 13:09:29 -0500 Subject: point people at pylons-discuss rather than pylons-devel --- docs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index ba71d5fff..5aecedc5d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -189,8 +189,8 @@ To report bugs, use the `issue tracker `_. If you've got questions that aren't answered by this documentation, -contact the `Pylons-devel maillist -`_ or join the `#pyramid +contact the `Pylons-discuss maillist +`_ or join the `#pyramid IRC channel `_. Browse and check out tagged and trunk versions of :app:`Pyramid` via -- cgit v1.2.3 From fcd8eb4e797e88c8899eea938a4bbfe391d6940e Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 17 Mar 2012 14:18:38 -0400 Subject: fix punctuation as per issue #493 --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 5aecedc5d..31c2fde6b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -175,7 +175,7 @@ Check this application out of version control via: `KARL `_ is a moderately-sized application (roughly 80K lines of Python code) built on top of :app:`Pyramid`. It is an open source web system for collaboration, organizational intranets, and knowledge -management, It provides facilities for wikis, calendars, manuals, searching, +management. It provides facilities for wikis, calendars, manuals, searching, tagging, commenting, and file uploads. See the `KARL site `_ for download and installation details. -- cgit v1.2.3 From 41b6ebf715b9c4935aa876c879e562e767d63fc0 Mon Sep 17 00:00:00 2001 From: Wayne Witzel III Date: Fri, 3 Aug 2012 07:52:54 -0700 Subject: Removing easy_install and demoing lines from index example. firstapp has installation chapter links and having peopel using pyramid outside a virtualenv is a bad idea --- docs/index.rst | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 31c2fde6b..699c89449 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,15 +13,9 @@ Here is one of the simplest :app:`Pyramid` applications you can make: .. literalinclude:: narr/helloworld.py -When saved to ``helloworld.py``, the above application can be run via: - -.. code-block:: text - - $ easy_install pyramid - $ python helloworld.py - -When you visit ``http://localhost:8080/hello/world`` in a browser, you will -see the text ``Hello, world!``. +After you install :app:`Pyramid` and run this application. When you visit +``http://localhost:8080/hello/world`` in a browser, you will see the +text ``Hello, world!`` See :ref:`firstapp_chapter` for a full explanation of how this application works. Read the :ref:`html_narrative_documentation` to understand how -- cgit v1.2.3 From db9468a22d8a9adbb29e70eb17c8ee9612797d61 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 3 Aug 2012 12:21:02 -0400 Subject: no period required here --- docs/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 699c89449..c84314274 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,9 +13,9 @@ Here is one of the simplest :app:`Pyramid` applications you can make: .. literalinclude:: narr/helloworld.py -After you install :app:`Pyramid` and run this application. When you visit -``http://localhost:8080/hello/world`` in a browser, you will see the -text ``Hello, world!`` +After you install :app:`Pyramid` and run this application, when you visit +``http://localhost:8080/hello/world`` in a browser, you will see the text +``Hello, world!`` See :ref:`firstapp_chapter` for a full explanation of how this application works. Read the :ref:`html_narrative_documentation` to understand how -- cgit v1.2.3 From b72ba1a98ebc6fc6c8d9a11ab1c340b89015e644 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 13 Sep 2012 02:05:19 -0400 Subject: add upgrading chapter, make docs render again --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index c84314274..321fe1fed 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -88,6 +88,7 @@ Narrative documentation in chapter form explaining how to use narr/advconfig narr/extconfig narr/scaffolding + narr/upgrading narr/threadlocals narr/zca -- cgit v1.2.3 From 54d3e3ecf8929f90373669b9682b9db3b4ce3290 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 15 Sep 2012 23:24:48 -0400 Subject: add a whatsnew-1.4 document --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 321fe1fed..4a9b3951b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,6 +37,7 @@ What's New .. toctree:: :maxdepth: 1 + whatsnew-1.4 whatsnew-1.3 whatsnew-1.2 whatsnew-1.1 -- cgit v1.2.3 From 37d2c224b804dfebe9ee217c7a536364eacdee15 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 16 Sep 2012 03:25:17 -0400 Subject: docs and test --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 4a9b3951b..faf8258c1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -83,6 +83,7 @@ Narrative documentation in chapter form explaining how to use narr/traversal narr/security narr/hybrid + narr/subrequest narr/hooks narr/introspector narr/extending -- cgit v1.2.3 From 0f2bbe521970aac9bf41f5ab9069256dac9f9cc5 Mon Sep 17 00:00:00 2001 From: Paul Winkler Date: Thu, 29 Nov 2012 13:15:26 -0500 Subject: Fix broken link to contributor docs --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index faf8258c1..406cc9b03 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -200,7 +200,7 @@ To check out the trunk via ``git``, use this command: To find out how to become a contributor to :app:`Pyramid`, please see the `contributor's section of the documentation -`_. +`_. Index and Glossary ================== -- cgit v1.2.3 From 812f65b895269f0c6b015af0276eef86b0b9b518 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Tue, 8 Jan 2013 23:14:20 +0200 Subject: the sample apps do not run on Py3k --- docs/index.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 406cc9b03..0d6113c15 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -138,6 +138,11 @@ Design Documents Sample Applications =================== +.. note:: + + These applications run only on Python 2.x, and so do some of their + dependencies. + `cluegun `_ is a simple pastebin application based on Rocky Burt's `ClueBin `_. It demonstrates form -- cgit v1.2.3 From e241c7e479b411a7f465b0a3d86021301702f8af Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Fri, 18 Jan 2013 23:58:04 +0200 Subject: make example links clickable, for convenience --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 0d6113c15..d4b7ed492 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,7 +14,7 @@ Here is one of the simplest :app:`Pyramid` applications you can make: .. literalinclude:: narr/helloworld.py After you install :app:`Pyramid` and run this application, when you visit -``http://localhost:8080/hello/world`` in a browser, you will see the text +``_ in a browser, you will see the text ``Hello, world!`` See :ref:`firstapp_chapter` for a full explanation of how this application -- cgit v1.2.3 From 9279d7ce253f70a17a0131ee061468d4600b20dc Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sat, 2 Mar 2013 13:47:40 +0200 Subject: no need for a separate API file --- docs/index.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index d4b7ed492..6e2568a21 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -112,12 +112,13 @@ platforms. API Documentation ================== -Documentation for every :app:`Pyramid` API. +Comprehensive reference material for every public API exposed by :app:`Pyramid`: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + :glob: - api + api/* Change History ============== -- cgit v1.2.3 From cd8ac801ac1ccefb81c2e015124be910cb8c93de Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Fri, 15 Feb 2013 00:48:08 +0200 Subject: update some links and fix others --- docs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 6e2568a21..bc711f8ff 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -189,7 +189,7 @@ The `Pylons Project web site `_ is the main online source of :app:`Pyramid` support and development information. To report bugs, use the `issue tracker -`_. +`_. If you've got questions that aren't answered by this documentation, contact the `Pylons-discuss maillist @@ -197,7 +197,7 @@ contact the `Pylons-discuss maillist IRC channel `_. Browse and check out tagged and trunk versions of :app:`Pyramid` via -the `Pyramid GitHub repository `_. +the `Pyramid GitHub repository `_. To check out the trunk via ``git``, use this command: .. code-block:: text -- cgit v1.2.3 From 47eaa189e115936a86357380accd8d472e4d9a6c Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Tue, 11 Jun 2013 14:54:58 -0400 Subject: About half of the first pass is done. --- docs/index.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index bc711f8ff..3c3adb9a6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -43,6 +43,16 @@ What's New whatsnew-1.1 whatsnew-1.0 +.. _html_getting_started: + +Getting Started +=============== + +.. toctree:: + :maxdepth: 2 + + getting_started/index + .. _html_narrative_documentation: Narrative documentation -- cgit v1.2.3 From 904981635bcaa54b9cd94538ac5c3db07cfe3ee7 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 13 Jul 2013 16:11:24 -0600 Subject: New tutorial: Using PyCharm with Pyramid --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index bc711f8ff..93b550d60 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -108,6 +108,7 @@ platforms. tutorials/wiki/index.rst tutorials/bfg/index.rst tutorials/modwsgi/index.rst + tutorials/pycharm/index.rst API Documentation ================== -- cgit v1.2.3 From a70d54c9ce1e635feb931eea63e41ea56bae4fb5 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 17 Jul 2013 04:53:03 -0600 Subject: Improve consistency between latexindex.rst and index.rst. --- docs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 93b550d60..d1a1e8ee7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -45,7 +45,7 @@ What's New .. _html_narrative_documentation: -Narrative documentation +Narrative Documentation ======================= Narrative documentation in chapter form explaining how to use @@ -111,7 +111,7 @@ platforms. tutorials/pycharm/index.rst API Documentation -================== +================= Comprehensive reference material for every public API exposed by :app:`Pyramid`: -- cgit v1.2.3 From 0d96b77150f1283a44acd0d9c2d2f74453d298a1 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 18 Jul 2013 18:17:20 -0400 Subject: version bump in setup.py conf.py CHANGES.txt, rejigger changes bugs vs. features --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 93b550d60..35646f3d2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,6 +37,7 @@ What's New .. toctree:: :maxdepth: 1 + whatsnew-1.5 whatsnew-1.4 whatsnew-1.3 whatsnew-1.2 -- cgit v1.2.3 From 456c171e31f166d48d1faf65273096f3a5b33d43 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 23 Jul 2013 05:18:06 -0600 Subject: Remove references to relocated PyCharm tutorial --- docs/index.rst | 1 - 1 file changed, 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 4be0ecd26..22b27039c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -109,7 +109,6 @@ platforms. tutorials/wiki/index.rst tutorials/bfg/index.rst tutorials/modwsgi/index.rst - tutorials/pycharm/index.rst API Documentation ================= -- cgit v1.2.3 From 133323b00defc9a8a6fbd8247cbb7125c2377f91 Mon Sep 17 00:00:00 2001 From: Darren Slatten Date: Sat, 27 Jul 2013 20:14:04 -0500 Subject: Removed `foreword.rst` from hidden `toctree` The `foreword.rst` file was used in printed versions, but currently it is not being used, so it shouldn't appear in any `toctree` directives. --- docs/index.rst | 1 - 1 file changed, 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 22b27039c..52b30df45 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -223,6 +223,5 @@ Index and Glossary :hidden: glossary - foreword.rst latexindex.rst -- cgit v1.2.3 From 0ed2c8f00d31caa224875a51b6a7723098b570ef Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 28 Jul 2013 14:06:49 -0400 Subject: use :orphan: for latexindex too --- docs/index.rst | 4 ---- 1 file changed, 4 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 52b30df45..5dfbbce1e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -216,12 +216,8 @@ Index and Glossary * :ref:`genindex` * :ref:`search` - -.. add glossary, foreword, and latexindex in a hidden toc to avoid warnings - .. toctree:: :hidden: glossary - latexindex.rst -- cgit v1.2.3 From 83fefbf3f92183d1d899c8449a03546dd3c022a3 Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Sat, 3 Aug 2013 11:23:20 -0400 Subject: "Web Application Development Framework" -> "Web Framework". Yay. --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 3c3adb9a6..4bbd2fd93 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ .. _index: ================================================= -The Pyramid Web Application Development Framework +The Pyramid Web Framework ================================================= :app:`Pyramid` is a small, fast, down-to-earth Python web application -- cgit v1.2.3 From efcf8f1c8b1e1140a5e9d9bb6fea558150ae7c29 Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Sat, 3 Aug 2013 11:34:05 -0400 Subject: Some more occurrences of "application framework". --- docs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 4bbd2fd93..09bbb5a9a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,8 +4,8 @@ The Pyramid Web Framework ================================================= -:app:`Pyramid` is a small, fast, down-to-earth Python web application -development framework. It is developed as part of the `Pylons Project +:app:`Pyramid` is a small, fast, down-to-earth Python web framework. It +is developed as part of the `Pylons Project `_. It is licensed under a `BSD-like license `_. -- cgit v1.2.3 From 71b83e5ea328b654f8463f567ecc054a55a7a90b Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Tue, 6 Aug 2013 10:12:42 -0400 Subject: Move sample code into subdirectories. Add sections for requests and views. --- docs/index.rst | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 09bbb5a9a..e61fe64d4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -48,10 +48,30 @@ What's New Getting Started =============== +Quick tour of major facilities in Pyramid, including a +:doc:`getting_started/quick_glance` high-level +overview. + .. toctree:: - :maxdepth: 2 + :maxdepth: 1 getting_started/index + getting_started/quick_glance + getting_started/scaffolds + getting_started/configuration + getting_started/routes + getting_started/views + getting_started/templates + getting_started/static_assets + getting_started/testing + getting_started/forms + getting_started/databases + getting_started/security + getting_started/json + getting_started/sessions + getting_started/internationalization + getting_started/special_views + getting_started/top_ten .. _html_narrative_documentation: @@ -192,6 +212,8 @@ management. It provides facilities for wikis, calendars, manuals, searching, tagging, commenting, and file uploads. See the `KARL site `_ for download and installation details. +.. _support-and-development: + Support and Development ======================= -- cgit v1.2.3 From ae901436a61563968cc31cc636f1fbeb5e85b528 Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Sun, 11 Aug 2013 09:53:00 -0400 Subject: Per discussion with Chris, just wrap up "getting started" as the Quick Tour. Still need to do more linking and perhaps add a section on root factories, authorization, authentication. --- docs/index.rst | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index e61fe64d4..c4b81ad7d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -48,30 +48,30 @@ What's New Getting Started =============== -Quick tour of major facilities in Pyramid, including a -:doc:`getting_started/quick_glance` high-level -overview. +If you are new to Pyramid, we have a few resources that can help you get +up to speed right away. Our *Quick Tour* shows a little about a lot: .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + + quick_tour + +Also: + +* To see a minimal Pyramid web application, check out `creating your first + Pyramid application <../narr/firstapp>`_. + +* For help getting Pyramid set up, try the `install guide + <../narr/install>`_. + +* To get the feel of how a Pyramid web application is created, go to the + `single file tasks tutorial `_ page. + +* Like learning by example? Check out to the `wiki tutorial + <../tutorials/wiki2/index.html>`_. + +* Need help? See `Support `_. - getting_started/index - getting_started/quick_glance - getting_started/scaffolds - getting_started/configuration - getting_started/routes - getting_started/views - getting_started/templates - getting_started/static_assets - getting_started/testing - getting_started/forms - getting_started/databases - getting_started/security - getting_started/json - getting_started/sessions - getting_started/internationalization - getting_started/special_views - getting_started/top_ten .. _html_narrative_documentation: -- cgit v1.2.3 From 5b47ba8ce8c8bdb149b92a2b35a5e7607ca6fc00 Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Mon, 12 Aug 2013 14:20:04 -0400 Subject: About to give Intersphinx a shot. --- docs/index.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index c4b81ad7d..f9f92e505 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -49,14 +49,15 @@ Getting Started =============== If you are new to Pyramid, we have a few resources that can help you get -up to speed right away. Our *Quick Tour* shows a little about a lot: +up to speed right away. .. toctree:: - :maxdepth: 2 + :hidden: quick_tour -Also: +* :doc:`quick_tour` goes through the major features in Pyramid, covering + a little about a lot. * To see a minimal Pyramid web application, check out `creating your first Pyramid application <../narr/firstapp>`_. @@ -67,10 +68,11 @@ Also: * To get the feel of how a Pyramid web application is created, go to the `single file tasks tutorial `_ page. -* Like learning by example? Check out to the `wiki tutorial - <../tutorials/wiki2/index.html>`_. +* Like learning by example? Check out to the :doc:`wiki tutorial + <../tutorials/wiki2/index>`. -* Need help? See `Support `_. +* Need help? See :ref:`Support and + Development `. .. _html_narrative_documentation: -- cgit v1.2.3 From 49d634bd813e63c3db5e56d29376126c2646182a Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Mon, 12 Aug 2013 19:29:23 -0400 Subject: All wrapped up, pre-merge. --- docs/index.rst | 77 +++++++++------------------------------------------------- 1 file changed, 12 insertions(+), 65 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index f9f92e505..d570e7811 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,18 +31,6 @@ Front Matter copyright.rst conventions.rst -What's New -========== - -.. toctree:: - :maxdepth: 1 - - whatsnew-1.4 - whatsnew-1.3 - whatsnew-1.2 - whatsnew-1.1 - whatsnew-1.0 - .. _html_getting_started: Getting Started @@ -59,17 +47,17 @@ up to speed right away. * :doc:`quick_tour` goes through the major features in Pyramid, covering a little about a lot. -* To see a minimal Pyramid web application, check out `creating your first - Pyramid application <../narr/firstapp>`_. - * For help getting Pyramid set up, try the `install guide <../narr/install>`_. -* To get the feel of how a Pyramid web application is created, go to the - `single file tasks tutorial `_ page. +* To see a minimal Pyramid web application, check out `creating your first + Pyramid application <../narr/firstapp>`_. -* Like learning by example? Check out to the :doc:`wiki tutorial - <../tutorials/wiki2/index>`. +* Like learning by example? Visit the official + :doc:`wiki tutorial <../tutorials/wiki2/index>` as well as the + community-contributed + :ref:`Pyramid tutorials `, which include + a :ref:`single file tasks tutorial `. * Need help? See :ref:`Support and Development `. @@ -158,6 +146,11 @@ Change History .. toctree:: :maxdepth: 1 + whatsnew-1.4 + whatsnew-1.3 + whatsnew-1.2 + whatsnew-1.1 + whatsnew-1.0 changes Design Documents @@ -168,52 +161,6 @@ Design Documents designdefense -Sample Applications -=================== - -.. note:: - - These applications run only on Python 2.x, and so do some of their - dependencies. - -`cluegun `_ is a simple pastebin -application based on Rocky Burt's `ClueBin -`_. It demonstrates form -processing, security, and the use of :term:`ZODB` within a :app:`Pyramid` -application. Check this application out via: - -.. code-block:: text - - git clone git://github.com/Pylons/cluegun.git - -`virginia `_ is a very simple dynamic -file rendering application. It is willing to render structured text -documents, HTML documents, and images from a filesystem directory. -It's also a good example of :term:`traversal`. An -earlier version of this application runs the `repoze.org -`_ website. Check this application out via: - -.. code-block:: text - - git clone git://github.com/Pylons/virginia.git - -`shootout `_ is an example "idea -competition" application by Carlos de la Guardia and Lukasz Fidosz. It -demonstrates :term:`URL dispatch`, simple authentication, integration -with `SQLAlchemy `_ and ``pyramid_simpleform``. -Check this application out of version control via: - -.. code-block:: text - - git clone git://github.com/Pylons/shootout.git - -`KARL `_ is a moderately-sized application (roughly -80K lines of Python code) built on top of :app:`Pyramid`. It is an open -source web system for collaboration, organizational intranets, and knowledge -management. It provides facilities for wikis, calendars, manuals, searching, -tagging, commenting, and file uploads. See the `KARL site -`_ for download and installation details. - .. _support-and-development: Support and Development -- cgit v1.2.3 From bf84d90b4dccb9fc52c8fe385e52f7a63e9a5535 Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Tue, 13 Aug 2013 07:36:48 -0400 Subject: Add Intersphinx for Beaker, clean up some broken references, change from pip to virtualenv (and give an explanation), explain virtualenv on Python 2.7. --- docs/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index d570e7811..550a5312e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -47,11 +47,11 @@ up to speed right away. * :doc:`quick_tour` goes through the major features in Pyramid, covering a little about a lot. -* For help getting Pyramid set up, try the `install guide - <../narr/install>`_. +* To see a minimal Pyramid web application, check out + :ref:`firstapp_chapter`. -* To see a minimal Pyramid web application, check out `creating your first - Pyramid application <../narr/firstapp>`_. +* For help getting Pyramid set up, try + :ref:`installing_chapter`. * Like learning by example? Visit the official :doc:`wiki tutorial <../tutorials/wiki2/index>` as well as the -- cgit v1.2.3 From 86553245537393611da769b3fcc29a23e9ef68b0 Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Tue, 13 Aug 2013 16:38:42 -0400 Subject: Shut up warning about latexindex not being in a TOC. Add back in a label that could be used for api_documentation references. --- docs/index.rst | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 9d38fb297..f899ddac3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -129,6 +129,8 @@ platforms. tutorials/bfg/index.rst tutorials/modwsgi/index.rst +.. _api_documentation: + API Documentation ================= @@ -202,4 +204,5 @@ Index and Glossary :hidden: glossary + latexindex -- cgit v1.2.3 From 65c60a85f90f7bf8f97848e7314b6d0e9ecc5599 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Fri, 16 Aug 2013 00:48:12 -0700 Subject: restore earlier fixes on latexindex don't make up funny words and use explicit 32- or 64-bit phrase --- docs/index.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index f899ddac3..d2a0008a8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -129,7 +129,7 @@ platforms. tutorials/bfg/index.rst tutorials/modwsgi/index.rst -.. _api_documentation: +.. _html_api_documentation: API Documentation ================= @@ -204,5 +204,4 @@ Index and Glossary :hidden: glossary - latexindex -- cgit v1.2.3 From f74033f797b82e7368c4e10eba22e0704bc32973 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 8 Sep 2013 05:31:35 -0400 Subject: remove bfg conversion chapter --- docs/index.rst | 1 - 1 file changed, 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index d2a0008a8..b0bda383f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -126,7 +126,6 @@ platforms. tutorials/wiki2/index.rst tutorials/wiki/index.rst - tutorials/bfg/index.rst tutorials/modwsgi/index.rst .. _html_api_documentation: -- cgit v1.2.3 From e7575491cb6d63e887dcdc40c2d86bb30ff775ca Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 8 Sep 2013 05:36:21 -0400 Subject: fix docs after removing bfg conversion chapter, add a prominent link to the quick tour --- docs/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index b0bda383f..2efe90cf7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,7 +20,8 @@ After you install :app:`Pyramid` and run this application, when you visit See :ref:`firstapp_chapter` for a full explanation of how this application works. Read the :ref:`html_narrative_documentation` to understand how :app:`Pyramid` is designed to scale from simple applications like this to -very large web applications. +very large web applications. To just dive in headfirst, read the +:doc:`quick_tour`. Front Matter ============ -- cgit v1.2.3 From b1b92284f496800a4dfd2cea72cb9be07ba8661c Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Fri, 13 Sep 2013 16:52:14 -0400 Subject: First cut at import of quick tutorial. --- docs/index.rst | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 2efe90cf7..78a00966d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -44,10 +44,14 @@ up to speed right away. :hidden: quick_tour + quick_tutorial/index * :doc:`quick_tour` goes through the major features in Pyramid, covering a little about a lot. +* :doc:`quick_tutorial/index` does the same, but in a tutorial format: + deeper treatment of each topic and with working code. + * To see a minimal Pyramid web application, check out :ref:`firstapp_chapter`. -- cgit v1.2.3 From 0f14d8db1b7ca13f62e967305e3583ff4b74abb1 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 3 May 2014 23:12:48 -0700 Subject: - add a reference --- docs/index.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 78a00966d..ac16ff237 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -119,6 +119,8 @@ Narrative documentation in chapter form explaining how to use narr/threadlocals narr/zca +.. _html_tutorials: + Tutorials ========= -- cgit v1.2.3 From cac2128fcc71ad2e0c9b9f22046dc47adb92dfd0 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 23 Dec 2014 03:23:19 -0800 Subject: - add an index to the API directory for better SEO --- docs/index.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index ac16ff237..fc7560e8f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -135,8 +135,6 @@ platforms. tutorials/wiki/index.rst tutorials/modwsgi/index.rst -.. _html_api_documentation: - API Documentation ================= @@ -146,6 +144,7 @@ Comprehensive reference material for every public API exposed by :app:`Pyramid`: :maxdepth: 1 :glob: + api/index api/* Change History -- cgit v1.2.3 From bfe0003efec3c93cf977b4ecf70615301fa12532 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 14 Apr 2015 11:46:29 -0400 Subject: add a whats new for 1.6 --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index fc7560e8f..0ee3557bf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -153,6 +153,7 @@ Change History .. toctree:: :maxdepth: 1 + whatsnew-1.6 whatsnew-1.5 whatsnew-1.4 whatsnew-1.3 -- cgit v1.2.3 From 8bb97b9894a3a038b3daa3880c5ea51a1cb8209e Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 5 Nov 2015 17:57:31 -0800 Subject: reorder, remove redundant statements, reduce verbosity, update headings, rewrap --- docs/index.rst | 149 +++++++++++++++++++++++++++++---------------------------- 1 file changed, 76 insertions(+), 73 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 0ee3557bf..70e0948f9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,10 +4,9 @@ The Pyramid Web Framework ========================= -:app:`Pyramid` is a small, fast, down-to-earth Python web framework. It -is developed as part of the `Pylons Project -`_. It is licensed under a `BSD-like license -`_. +:app:`Pyramid` is a small, fast, down-to-earth Python web framework. It is +developed as part of the `Pylons Project `_. +It is licensed under a `BSD-like license `_. Here is one of the simplest :app:`Pyramid` applications you can make: @@ -15,30 +14,17 @@ Here is one of the simplest :app:`Pyramid` applications you can make: After you install :app:`Pyramid` and run this application, when you visit ``_ in a browser, you will see the text -``Hello, world!`` +``Hello, world!`` See :ref:`firstapp_chapter` for a full explanation of how +this application works. -See :ref:`firstapp_chapter` for a full explanation of how this application -works. Read the :ref:`html_narrative_documentation` to understand how -:app:`Pyramid` is designed to scale from simple applications like this to -very large web applications. To just dive in headfirst, read the -:doc:`quick_tour`. - -Front Matter -============ - -.. toctree:: - :maxdepth: 1 - - copyright.rst - conventions.rst .. _html_getting_started: Getting Started =============== -If you are new to Pyramid, we have a few resources that can help you get -up to speed right away. +If you are new to Pyramid, we have a few resources that can help you get up to +speed right away. .. toctree:: :hidden: @@ -46,26 +32,65 @@ up to speed right away. quick_tour quick_tutorial/index -* :doc:`quick_tour` goes through the major features in Pyramid, covering - a little about a lot. +* :doc:`quick_tour` gives an overview of the major features in Pyramid, + covering a little about a lot. -* :doc:`quick_tutorial/index` does the same, but in a tutorial format: - deeper treatment of each topic and with working code. +* :doc:`quick_tutorial/index` is similar to the Quick Tour, but in a tutorial + format, with somewhat deeper treatment of each topic and with working code. -* To see a minimal Pyramid web application, check out - :ref:`firstapp_chapter`. +* Like learning by example? Visit the official :ref:`html_tutorials` as well as + the community-contributed :ref:`Pyramid tutorials + `, which include a :ref:`Todo List Application + in One File `. -* For help getting Pyramid set up, try - :ref:`installing_chapter`. +* For help getting Pyramid set up, try :ref:`installing_chapter`. -* Like learning by example? Visit the official - :doc:`wiki tutorial <../tutorials/wiki2/index>` as well as the - community-contributed - :ref:`Pyramid tutorials `, which include - a :ref:`single file tasks tutorial `. +* Need help? See :ref:`Support and Development `. -* Need help? See :ref:`Support and - Development `. + +.. _html_tutorials: + +Tutorials +========= + +Official tutorials explaining how to use :app:`Pyramid` to build various types +of applications, and how to deploy :app:`Pyramid` applications to various +platforms. + +.. toctree:: + :maxdepth: 1 + + tutorials/wiki2/index.rst + tutorials/wiki/index.rst + tutorials/modwsgi/index.rst + + +.. _support-and-development: + +Support and Development +======================= + +The `Pylons Project web site `_ is the main online +source of :app:`Pyramid` support and development information. + +To report bugs, use the `issue tracker +`_. + +If you've got questions that aren't answered by this documentation, contact the +`Pylons-discuss maillist `_ or +join the `#pyramid IRC channel `_. + +Browse and check out tagged and trunk versions of :app:`Pyramid` via the +`Pyramid GitHub repository `_. To check out +the trunk via ``git``, use this command: + +.. code-block:: text + + git clone git@github.com:Pylons/pyramid.git + +To find out how to become a contributor to :app:`Pyramid`, please see the +`contributor's section of the documentation +`_. .. _html_narrative_documentation: @@ -73,8 +98,7 @@ up to speed right away. Narrative Documentation ======================= -Narrative documentation in chapter form explaining how to use -:app:`Pyramid`. +Narrative documentation in chapter form explaining how to use :app:`Pyramid`. .. toctree:: :maxdepth: 2 @@ -119,26 +143,12 @@ Narrative documentation in chapter form explaining how to use narr/threadlocals narr/zca -.. _html_tutorials: - -Tutorials -========= - -Tutorials explaining how to use :app:`Pyramid` to build various types of -applications, and how to deploy :app:`Pyramid` applications to various -platforms. - -.. toctree:: - :maxdepth: 2 - - tutorials/wiki2/index.rst - tutorials/wiki/index.rst - tutorials/modwsgi/index.rst API Documentation ================= -Comprehensive reference material for every public API exposed by :app:`Pyramid`: +Comprehensive reference material for every public API exposed by +:app:`Pyramid`: .. toctree:: :maxdepth: 1 @@ -147,6 +157,7 @@ Comprehensive reference material for every public API exposed by :app:`Pyramid`: api/index api/* + Change History ============== @@ -162,6 +173,7 @@ Change History whatsnew-1.0 changes + Design Documents ================ @@ -170,33 +182,24 @@ Design Documents designdefense -.. _support-and-development: -Support and Development -======================= +Copyright, Trademarks, and Attributions +======================================= -The `Pylons Project web site `_ is the main online -source of :app:`Pyramid` support and development information. +.. toctree:: + :maxdepth: 1 -To report bugs, use the `issue tracker -`_. + copyright -If you've got questions that aren't answered by this documentation, -contact the `Pylons-discuss maillist -`_ or join the `#pyramid -IRC channel `_. -Browse and check out tagged and trunk versions of :app:`Pyramid` via -the `Pyramid GitHub repository `_. -To check out the trunk via ``git``, use this command: +Typographical Conventions +========================= -.. code-block:: text +.. toctree:: + :maxdepth: 1 - git clone git@github.com:Pylons/pyramid.git + conventions -To find out how to become a contributor to :app:`Pyramid`, please see the -`contributor's section of the documentation -`_. Index and Glossary ================== -- cgit v1.2.3 From 28bfdfcb493c577fb445f999d71ca77a096040c3 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 7 Nov 2015 00:39:06 -0800 Subject: minor grammar, fix .rst markup, rewrap to 79 columns --- docs/index.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 70e0948f9..e792b9905 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -82,11 +82,15 @@ join the `#pyramid IRC channel `_. Browse and check out tagged and trunk versions of :app:`Pyramid` via the `Pyramid GitHub repository `_. To check out -the trunk via ``git``, use this command: +the trunk via ``git``, use either command: .. code-block:: text + # If you have SSH keys configured on GitHub: git clone git@github.com:Pylons/pyramid.git + + # Otherwise, HTTPS will work, using your GitHub login: + git clone https://github.com/Pylons/pyramid.git To find out how to become a contributor to :app:`Pyramid`, please see the `contributor's section of the documentation -- cgit v1.2.3 From 5ff3d2dfdbf936d115e3486696401ad7dbffedc3 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 21 Dec 2015 01:24:34 -0800 Subject: - add p* scripts - add links to p* scripts - add a blank line to keep indices and labels better visually related to the subsequent heading --- docs/index.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index e792b9905..8c8a0a18d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -162,6 +162,19 @@ Comprehensive reference material for every public API exposed by api/* +``p*`` Scripts Documentation +============================ + +``p*`` scripts included with :app:`Pyramid`:. + +.. toctree:: + :maxdepth: 1 + :glob: + + pscripts/index + pscripts/* + + Change History ============== -- cgit v1.2.3 From 8a80b1094cf0ba762b30a9bae56831d4daf69e3c Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 5 Jan 2016 04:33:29 -0800 Subject: update links to tutorials in cookbook --- docs/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 8c8a0a18d..9a34f088b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -39,9 +39,9 @@ speed right away. format, with somewhat deeper treatment of each topic and with working code. * Like learning by example? Visit the official :ref:`html_tutorials` as well as - the community-contributed :ref:`Pyramid tutorials - `, which include a :ref:`Todo List Application - in One File `. + the community-contributed :ref:`Pyramid Tutorials + ` and :ref:`Pyramid Cookbook + `. * For help getting Pyramid set up, try :ref:`installing_chapter`. -- cgit v1.2.3 From 34515f33b3e391dd1c0c727bf5ef4af586b57889 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 14 Jan 2016 02:55:04 -0800 Subject: Rename Cookbook to Pyramid Community Cookbook - use .rst intersphinx labels for pages instead of broken URLs --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 9a34f088b..ba6ca1e49 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,7 +40,7 @@ speed right away. * Like learning by example? Visit the official :ref:`html_tutorials` as well as the community-contributed :ref:`Pyramid Tutorials - ` and :ref:`Pyramid Cookbook + ` and :ref:`Pyramid Community Cookbook `. * For help getting Pyramid set up, try :ref:`installing_chapter`. -- cgit v1.2.3 From 311482f8526e27b2d38b4c600706f490c7ff44e9 Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Fri, 15 Apr 2016 00:34:33 -0500 Subject: link the whatsnew-1.7 --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index ba6ca1e49..aecc26d2e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -181,6 +181,7 @@ Change History .. toctree:: :maxdepth: 1 + whatsnew-1.7 whatsnew-1.6 whatsnew-1.5 whatsnew-1.4 -- cgit v1.2.3