convert remainder of docs to use pyramid instead of repoze.bfg

docs/api/testing.rst

@@ -15,8 +15,6 @@
 
   .. autofunction:: registerView
 
-  .. autofunction:: registerViewPermission
-
   .. autofunction:: registerUtility
 
   .. autofunction:: registerAdapter
@@ -25,8 +23,6 @@
 
   .. autofunction:: registerRoute
 
-  .. autofunction:: registerRoutesMapper
-
   .. autofunction:: registerSettings
 
   .. autofunction:: setUp

docs/authorintro.rst

@@ -2,10 +2,10 @@
  Author Introduction
 =====================
 
-Welcome to "The :mod:`repoze.bfg` Web Application Framework".  In this
+Welcome to "The :mod:`pyramid` Web Application Framework".  In this
 introduction, I'll describe the audience for this book, I'll describe
 the book content, I'll provide some context regarding the genesis of
-:mod:`repoze.bfg`, and I'll thank some important people.
+:mod:`pyramid`, and I'll thank some important people.
 
 I hope you enjoy both this book and the software it documents.  I've
 had a blast writing both.
@@ -42,7 +42,7 @@ book.  For example, the book doesn't try to define common web-related
 concepts like "URL" or "query string."  Likewise, the book describes
 various interactions in terms of the HTTP protocol, but it does not
 describe how the HTTP protocol works in detail.  Like any good web
-framework, though, :mod:`repoze.bfg` shields you from needing to know
+framework, though, :mod:`pyramid` shields you from needing to know
 most of the gory details of web protocols and low-level data
 structures. As a result, you can usually avoid becoming "blocked"
 while you read this book even if you don't yet deeply understand web
@@ -58,10 +58,10 @@ This book is divided into four major parts:
 
 :ref:`narrative_documentation`
 
-  This is documentation which describes :mod:`repoze.bfg` concepts in
+  This is documentation which describes :mod:`pyramid` concepts in
   narrative form, written in a largely conversational tone.  Each
   narrative documentation chapter describes an isolated
-  :mod:`repoze.bfg` concept.  You should be able to get useful
+  :mod:`pyramid` concept.  You should be able to get useful
   information out of the narrative chapters if you read them
   out-of-order, or when you need only a reminder about a particular
   topic while you're developing an application.
@@ -71,29 +71,32 @@ This book is divided into four major parts:
   Each tutorial builds a sample application or implements a set of
   concepts with a sample; it then describes the application or
   concepts in terms of the sample.  You should read the tutorials if
-  you want a guided tour of :mod:`repoze.bfg`.
+  you want a guided tour of :mod:`pyramid`.
 
 :ref:`api_reference`
 
   Comprehensive reference material for every public API exposed by
-  :mod:`repoze.bfg`.  The API documentation is organized
+  :mod:`pyramid`.  The API documentation is organized
   alphabetically by module name.
 
 :ref:`zcml_reference`
 
   Comprehensive reference material for every :term:`ZCML directive`
-  provided by :mod:`repoze.bfg`.  The ZCML directive documentation is
+  provided by :mod:`pyramid`.  The ZCML directive documentation is
   organized alphabetically by directive name.
 
 .. index::
    single: repoze.zope2
    single: Zope 3
    single: Zope 2
    single: repoze.bfg genesis
+   single: pyramid genesis
 
 The Genesis of :mod:`repoze.bfg`
 ================================
 
+Before the end of 2010, :mod:`pyramid` was known as :mod:`repoze.bfg`.
+
 I wrote :mod:`repoze.bfg` after many years of writing applications
 using :term:`Zope`.  Zope provided me with a lot of mileage: it wasn't
 until almost a decade of successfully creating applications using it
@@ -130,13 +133,16 @@ I decided that in the long term, creating a simpler framework that
 retained features I had become accustomed to when developing Zope
 applications was a more reasonable idea than continuing to use any
 Zope publisher or living with the limitations and unfamiliarities of a
-different framework.  The result is what is now :mod:`repoze.bfg`.
+different framework.  The result is what is now :mod:`pyramid`.
+
+The Genesis of :mod:`pyramid`
+=============================
 
-It is immodest to say so, but I believe :mod:`repoze.bfg` has turned
-out to be the very best Python web framework available today, bar
-none.  It combines all the "good parts" from other web frameworks into
-a cohesive whole that is reliable, down-to-earth, flexible, speedy,
-and well-documented.
+What was :mod:`repoze.bfg` has become :mod:`pyramid` as the result of
+a coalition built between the :term:`Repoze` and :term:`Pylons`
+community throughout the year 2010.  By merging technology, we're able
+to reduce duplication of effort, and take advantage of more of each
+others' technology.
 
 .. index::
    single: Bicking, Ian

docs/changes.rst

@@ -1,4 +1,4 @@
-:mod:`repoze.bfg` Change History
+:mod:`pyramid` Change History
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. include:: ../CHANGES.txt

docs/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# repoze.bfg documentation build configuration file, created by
+# pyramid documentation build configuration file, created by
 # sphinx-quickstart on Wed Jul 16 13:18:14 2008.
 #
 # This file is execfile()d with the current directory set to its containing dir.
@@ -54,14 +54,14 @@ def raw(*arg):
 master_doc = 'index'
 
 # General substitutions.
-project = 'The repoze.bfg Web Application Framework'
+project = 'The Pyramid Web Application Development Framework'
 copyright = '2008-2010, Agendaless Consulting'
 
 # The default replacements for |version| and |release|, also used in various
 # other places throughout the built documents.
 #
 # The short X.Y version.
-version = '1.3a15'
+version = '1.0a1'
 # The full version, including alpha/beta/rc tags.
 release = version
 
@@ -105,7 +105,7 @@ def raw(*arg):
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = 'The repoze.bfg Web Application Framework v%release%'
+#html_title = 'The Pyramid Web Application Development Framework v%release%'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
@@ -174,7 +174,8 @@ def raw(*arg):
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
 latex_documents = [
-  ('latexindex', 'repozebfg.tex', 'The repoze.bfg Web Application Framework',
+  ('latexindex', 'repozebfg.tex',
+   'The Pyramid Web Application Development Framework',
    'Chris McDonough', 'manual'),
     ]
 
@@ -309,7 +310,7 @@ def raw(*arg):
     'wrapperclass':'book',
     'date':'',
     'releasename':'Version',
-    'title':r'The repoze.bfg Web Application \newline Framework',
+    'title':r'The Pyramid Web Application \newline Development Framework',
 #    'pointsize':'12pt', # uncomment for 12pt version
 }
 
@@ -373,28 +374,6 @@ def setup(app):
     app.add_directive('mainmatter', mainmatter, 1, (0, 0, 0))
     app.add_directive('backmatter', backmatter, 1, (0, 0, 0))
 
-# strip "repoze.bfg." from all inline literals
-
-from sphinx.writers.latex import LaTeXTranslator
-
-def visit_literal(self, node):
-        self.no_contractions += 1
-        content = self.encode(node.astext().strip())
-        self.no_contractions -= 1
-        if self.in_title:
-            self.body.append(r'\texttt{%s}' % content)
-        elif node.has_key('role') and node['role'] == 'samp':
-            self.body.append(r'\samp{%s}' % content)
-        else:
-            # XXX special treatment of overlong ``repoze.bfg.foo``
-            # literals.
-            if 'repoze.bfg.' in content:
-                content = content.replace('repoze.bfg.', '')
-            self.body.append(r'\code{%s}' % content)
-        raise nodes.SkipNode
-
-LaTeXTranslator.visit_literal = visit_literal
-
 # turn off all line numbers in latex formatting
 
 ## from pygments.formatters import LatexFormatter
@@ -410,7 +389,7 @@ def visit_literal(self, node):
 # -- Options for Epub output ---------------------------------------------------
 
 # Bibliographic Dublin Core info.
-epub_title = 'The repoze.bfg Web Application Framework, Version 1.3'
+epub_title = 'The Pyramid Web Application Development Framework, Version 1.0'
 epub_author = 'Chris McDonough'
 epub_publisher = 'Agendaless Consulting'
 epub_copyright = '2008-2010'
@@ -427,7 +406,7 @@ def visit_literal(self, node):
 epub_identifier = '0615345379'
 
 # A unique identification for the text.
-epub_uid = 'The repoze.bfg Web Application Framework, Version 1.3-v0'
+epub_uid = 'The Pyramid Web Application Development Framework, Version 1.0'
 
 # HTML files that should be inserted before the pages created by sphinx.
 # The format is a list of tuples containing the path and title.

docs/conventions.rst

@@ -75,19 +75,3 @@ discussed on a page, is rendered like so:
 
    Sidebar information.
 
-In printed versions of this book, Python modules classes, methods,
-functions, and attributes that are part of the :mod:`repoze.bfg`
-module are referenced in paragraph text.  These are contracted to omit
-the ``repoze.bfg`` prefix to reduce redundancy and increase
-readability.  Therefore, where you might expect:
-
-  .. code-block:: text
-
-     repoze.bfg.configuration.Configurator.add_view (pp. XXX)
-
-Instead a contracted version will be rendered:
-
-  .. code-block:: text
-
-     configuration.Configurator.add_view (pp. XXX)
-

docs/copyright.rst

@@ -1,7 +1,7 @@
 Copyright, Trademarks, and Attributions
 =======================================
 
-*The repoze.bfg Web Application Framework, Version 1.2*
+*The Pyramid Web Application Development Framework, Version 1.0*
 
 by Chris McDonough
 
@@ -26,9 +26,9 @@ similar license to this one.
 
 .. note::
 
-   While the :mod:`repoze.bfg` documentation is offered under the
+   While the :mod:`pyramid` documentation is offered under the
    Creative Commons Attribution-Nonconmmercial-Share Alike 3.0 United
-   States License, the :mod:`repoze.bfg` *software* is offered under a
+   States License, the :mod:`pyramid` *software* is offered under a
    `less restrictive (BSD-like) license
    <http://repoze.org/license.html>`_ .
 
@@ -74,21 +74,16 @@ Contacting The Publisher
 Please send documentation licensing inquiries, translation inquiries,
 and other business communications to `Agendaless Consulting
 <mailto:webmaster@agendaless.com>`_.  Please send software and other
-technical queries to the `repoze-dev maillist
-<http://lists.repoze.org/listinfo/repoze-dev>`_.
+technical queries to the `Pylons-discuss maillist
+<http://groups.google.com/group/pylons-discuss>`_.
 
 HTML Version and Source Code
 ----------------------------
 
 An HTML version of this book is freely available via
-http://bfg.repoze.org.
+http://pylonshq.com/pyramid.
 
 The source code for the examples used in this book are available
-within the :mod:`repoze.bfg` software distribution, always available
-via http://bfg.repoze.org.
-
-Errata
-------
-
-Errata for this book will be placed at `http://bfg.repoze.org/book_errata`.
+within the :mod:`pyramid` software distribution, always available
+via http://pylonshq.com/pyramid.