diff options
| author | Chris McDonough <chrism@plope.com> | 2012-03-05 10:13:11 -0500 |
|---|---|---|
| committer | Chris McDonough <chrism@plope.com> | 2012-03-05 10:13:11 -0500 |
| commit | ca9f88da0aab4501ec05a9d9ac9a40e131a131dc (patch) | |
| tree | c5749af5fab33ea764fb9b12d5bc2396220df04e /docs | |
| parent | 09c2ed0292cf787e3ddda0f0a95ff5992a80749f (diff) | |
| parent | 13305e14b74c4ef6bbd44817ed0eac5c36499c2b (diff) | |
| download | pyramid-ca9f88da0aab4501ec05a9d9ac9a40e131a131dc.tar.gz pyramid-ca9f88da0aab4501ec05a9d9ac9a40e131a131dc.tar.bz2 pyramid-ca9f88da0aab4501ec05a9d9ac9a40e131a131dc.zip | |
Merge branch '1.3-branch'
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 56 | ||||
| -rw-r--r-- | docs/narr/hooks.rst | 4 |
2 files changed, 20 insertions, 40 deletions
diff --git a/docs/index.rst b/docs/index.rst index cb632d5b2..5aecedc5d 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 <http://svn.repoze.org/bfgsite/trunk>`_ is the software which -runs the `bfg.repoze.org <http://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 <http://karlproject.org>`_ 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 <http://karlproject.org>`_ 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 <http://karlproject.org>`_ for download and installation details. Support and Development @@ -209,8 +189,8 @@ To report bugs, use the `issue tracker <http://github.com/Pylons/pyramid/issues>`_. If you've got questions that aren't answered by this documentation, -contact the `Pylons-devel maillist -<http://groups.google.com/group/pylons-devel>`_ or join the `#pyramid +contact the `Pylons-discuss maillist +<http://groups.google.com/group/pylons-discuss>`_ or join the `#pyramid IRC channel <irc://irc.freenode.net/#pyramid>`_. Browse and check out tagged and trunk versions of :app:`Pyramid` via diff --git a/docs/narr/hooks.rst b/docs/narr/hooks.rst index 24ea5de21..b6e3dd163 100644 --- a/docs/narr/hooks.rst +++ b/docs/narr/hooks.rst @@ -474,7 +474,7 @@ via configuration. from pyramid.config import Configurator from myapp.traversal import Traverser config = Configurator() - config.set_traverser(Traverser) + config.add_traverser(Traverser) In the example above, ``myapp.traversal.Traverser`` is assumed to be a class that implements the following interface: @@ -524,7 +524,7 @@ used. Otherwise, the default traverser would be used. For example: from myapp.resources import MyRoot from pyramid.config import Configurator config = Configurator() - config.set_traverser(Traverser, MyRoot) + config.add_traverser(Traverser, MyRoot) If the above stanza was added to a Pyramid ``__init__.py`` file's ``main`` function, :app:`Pyramid` would use the ``myapp.traversal.Traverser`` only |
