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 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