summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2013-03-21 13:32:14 -0700
committerSteve Piercy <web@stevepiercy.com>2013-03-21 13:32:14 -0700
commita17c712f7f836b3506be069f60ee9ed8a8edb42b (patch)
treed42a28e8b692fd6da1289c2ca8f99a18a8a3e59f /docs
parent124daa3f3de2350ee4079d684736acd10b415046 (diff)
parentf38126c3214c936f022e68a1cac88c3cd8644879 (diff)
downloadpyramid-a17c712f7f836b3506be069f60ee9ed8a8edb42b.tar.gz
pyramid-a17c712f7f836b3506be069f60ee9ed8a8edb42b.tar.bz2
pyramid-a17c712f7f836b3506be069f60ee9ed8a8edb42b.zip
Merge remote-tracking branch 'upstream/master'
Conflicts: docs/tutorials/wiki2/installation.rst
Diffstat (limited to 'docs')
-rw-r--r--docs/api/paster.rst2
-rw-r--r--docs/conf.py11
-rw-r--r--docs/narr/router.rst2
-rw-r--r--docs/narr/urldispatch.rst7
-rw-r--r--docs/narr/viewconfig.rst4
-rw-r--r--docs/tutorials/wiki2/basiclayout.rst6
-rw-r--r--docs/tutorials/wiki2/definingmodels.rst11
-rw-r--r--docs/tutorials/wiki2/installation.rst18
8 files changed, 40 insertions, 21 deletions
diff --git a/docs/api/paster.rst b/docs/api/paster.rst
index bde128e05..edc3738fc 100644
--- a/docs/api/paster.rst
+++ b/docs/api/paster.rst
@@ -9,6 +9,6 @@
.. autofunction:: get_app(config_uri, name=None, options=None)
- .. autofunction:: get_appsettings(config_uri, name=None)
+ .. autofunction:: get_appsettings(config_uri, name=None, options=None)
.. autofunction:: setup_logging(config_uri)
diff --git a/docs/conf.py b/docs/conf.py
index 8d22d4d42..eff6db488 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -55,13 +55,14 @@ extensions = [
# Looks for objects in external projects
intersphinx_mapping = {
- 'who': ('http://docs.repoze.org/who/2.0', None),
- 'python': ('http://docs.python.org', None),
- 'python3': ('http://docs.python.org/3', None),
- 'tstring':
+ 'sqla': ('http://docs.sqlalchemy.org/en/latest', None),
+ 'who': ('http://docs.repoze.org/who/latest', None),
+ 'python': ('http://docs.python.org', None),
+ 'python3': ('http://docs.python.org/3', None),
+ 'tstring':
('http://docs.pylonsproject.org/projects/translationstring/en/latest',
None),
- 'venusian':
+ 'venusian':
('http://docs.pylonsproject.org/projects/venusian/en/latest', None),
}
diff --git a/docs/narr/router.rst b/docs/narr/router.rst
index b78362066..ac3deefdc 100644
--- a/docs/narr/router.rst
+++ b/docs/narr/router.rst
@@ -46,7 +46,7 @@ request enters a :app:`Pyramid` application through to the point that
:class:`~pyramid.interfaces.IRoute` object representing the route which
matched. The root object associated with the route found is also
generated: if the :term:`route configuration` which matched has an
- associated a ``factory`` argument, this factory is used to generate the
+ associated ``factory`` argument, this factory is used to generate the
root object, otherwise a default :term:`root factory` is used.
#. If a route match was *not* found, and a ``root_factory`` argument was
diff --git a/docs/narr/urldispatch.rst b/docs/narr/urldispatch.rst
index 181b07259..0656a1833 100644
--- a/docs/narr/urldispatch.rst
+++ b/docs/narr/urldispatch.rst
@@ -16,12 +16,13 @@ receives the :term:`request` and returns a :term:`response` object.
High-Level Operational Overview
-------------------------------
-If route configuration is present in an application, the :app:`Pyramid`
+If any route configuration is present in an application, the :app:`Pyramid`
:term:`Router` checks every incoming request against an ordered set of URL
matching patterns present in a *route map*.
If any route pattern matches the information in the :term:`request`,
-:app:`Pyramid` will invoke :term:`view lookup` to find a matching view.
+:app:`Pyramid` will invoke the :term:`view lookup` process to find a
+matching view.
If no route pattern in the route map matches the information in the
:term:`request` provided in your application, :app:`Pyramid` will fail over
@@ -81,7 +82,7 @@ this is a portion of your project's ``__init__.py``:
Note that we don't call :meth:`~pyramid.config.Configurator.add_view` in this
setup code. However, the above :term:`scan` execution
-``config.scan('mypackage')`` will pick up all :term:`configuration
+``config.scan('mypackage')`` will pick up each :term:`configuration
decoration`, including any objects decorated with the
:class:`pyramid.view.view_config` decorator in the ``mypackage`` Python
package. For example, if you have a ``views.py`` in your package, a scan will
diff --git a/docs/narr/viewconfig.rst b/docs/narr/viewconfig.rst
index d3221db3c..e0338c442 100644
--- a/docs/narr/viewconfig.rst
+++ b/docs/narr/viewconfig.rst
@@ -62,9 +62,9 @@ particular view callable.
:term:`View predicate` attributes are an important part of view configuration
that enables the :term:`view lookup` subsystem to find and invoke the
-appropriate view. The greater number of predicate attributes possessed by a
+appropriate view. The greater the number of predicate attributes possessed by a
view's configuration, the more specific the circumstances need to be before
-the registered view callable will be invoked. The fewer number of predicates
+the registered view callable will be invoked. The fewer the number of predicates
which are supplied to a particular view configuration, the more likely it is
that the associated view callable will be invoked. A view with five
predicates will always be found and evaluated before a view with two, for
diff --git a/docs/tutorials/wiki2/basiclayout.rst b/docs/tutorials/wiki2/basiclayout.rst
index 86fe97956..eb2445864 100644
--- a/docs/tutorials/wiki2/basiclayout.rst
+++ b/docs/tutorials/wiki2/basiclayout.rst
@@ -43,9 +43,9 @@ above is executed. It accepts some settings and returns a :term:`WSGI`
application. (See :ref:`startup_chapter` for more about ``pserve``.)
The main function first creates a :term:`SQLAlchemy` database engine using
-``engine_from_config`` from the ``sqlalchemy.`` prefixed settings in the
-``development.ini`` file's ``[app:main]`` section. This will be a URI
-(something like ``sqlite://``):
+:func:`sqlalchemy.engine_from_config` from the ``sqlalchemy.`` prefixed
+settings in the ``development.ini`` file's ``[app:main]`` section.
+This will be a URI (something like ``sqlite://``):
.. literalinclude:: src/basiclayout/tutorial/__init__.py
:lines: 13
diff --git a/docs/tutorials/wiki2/definingmodels.rst b/docs/tutorials/wiki2/definingmodels.rst
index bd1cb00d7..60427a911 100644
--- a/docs/tutorials/wiki2/definingmodels.rst
+++ b/docs/tutorials/wiki2/definingmodels.rst
@@ -34,7 +34,7 @@ sample and we're not going to use it.
Then, we added a ``Page`` class. Because this is a SQLAlchemy application,
this class inherits from an instance of
-:class:`sqlalchemy.ext.declarative.declarative_base`.
+:func:`sqlalchemy.ext.declarative.declarative_base`.
.. literalinclude:: src/models/tutorial/models.py
:pyobject: Page
@@ -45,9 +45,10 @@ As you can see, our ``Page`` class has a class level attribute
``__tablename__`` which equals the string ``'pages'``. This means that
SQLAlchemy will store our wiki data in a SQL table named ``pages``. Our
``Page`` class will also have class-level attributes named ``id``, ``name`` and
-``data`` (all instances of :class:`sqlalchemy.Column`). These will map to
-columns in the ``pages`` table. The ``id`` attribute will be the primary key
-in the table. The ``name`` attribute will be a text attribute, each value of
+``data`` (all instances of :class:`sqlalchemy.schema.Column`).
+These will map to columns in the ``pages`` table.
+The ``id`` attribute will be the primary key in the table.
+The ``name`` attribute will be a text attribute, each value of
which needs to be unique within the column. The ``data`` attribute is a text
attribute that will hold the body of each page.
@@ -77,8 +78,6 @@ following:
Installing the Project and re-initializing the Database
-------------------------------------------------------
-Redo the steps in :ref:`installing_project_in_dev_mode`.
-
Because our model has changed, in order to reinitialize the database, we need
to rerun the ``initialize_tutorial_db`` command to pick up the changes you've made
to both the models.py file and to the initializedb.py file.
diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst
index a8b8ee877..dd7c76d5f 100644
--- a/docs/tutorials/wiki2/installation.rst
+++ b/docs/tutorials/wiki2/installation.rst
@@ -70,6 +70,7 @@ Install Pyramid Into the Virtual Python Environment
Install SQLite3 and Its Development Packages
--------------------------------------------
+<<<<<<< HEAD
If you used a package manager to install your Python or if you compiled
your Python from source, then you must install SQLite3 and its
development packages. If you downloaded your Python as an installer
@@ -78,23 +79,40 @@ the next section :ref:`sql_making_a_project`..
If you need to install the SQLite3 packages, then, for example, using
the Debian system and apt-get, the command would be the following:
+=======
+Install SQLite3 and its development packages if you don't already
+have them installed. Usually this is via your system's package
+manager. On a Debian system, this would be:
+>>>>>>> upstream/master
.. code-block:: text
$ sudo apt-get install libsqlite3-dev
+<<<<<<< HEAD
Change Directory to Your Virtual Python Environment
---------------------------------------------------
Change directory to the ``pyramidtut`` directory.
**On UNIX:**
+=======
+Entering the virtualenv
+-----------------------
+
+Do not forget to switch to the ``pyramidtut`` directory.
+In order to do so, run this command if you are on Unix:
+>>>>>>> upstream/master
.. code-block:: text
$ cd pyramidtut
+<<<<<<< HEAD
**On Windows**
+=======
+And run this if you are on Windows:
+>>>>>>> upstream/master
.. code-block:: text