From 55241cc181d016d59a73373942b654ef97f8e45c Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Thu, 14 Feb 2013 00:47:24 +0200 Subject: use 'rfc' role to link to the RFCs; this fixes one link, for free --- pyramid/httpexceptions.py | 6 +++--- pyramid/interfaces.py | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/pyramid/httpexceptions.py b/pyramid/httpexceptions.py index 64afc346a..4e351bf68 100644 --- a/pyramid/httpexceptions.py +++ b/pyramid/httpexceptions.py @@ -7,9 +7,9 @@ single HTTP status code. Each class is a subclass of the :class:`~HTTPException`. Each exception class is also a :term:`response` object. -Each exception class has a status code according to `RFC 2068 -`_: codes with 100-300 are not really -errors; 400s are client errors, and 500s are server errors. +Each exception class has a status code according to :rfc:`2068`: +codes with 100-300 are not really errors; 400s are client errors, +and 500s are server errors. Exception HTTPException diff --git a/pyramid/interfaces.py b/pyramid/interfaces.py index 0a5ec9588..4fb4d615c 100644 --- a/pyramid/interfaces.py +++ b/pyramid/interfaces.py @@ -57,9 +57,9 @@ class IApplicationCreated(Interface): IWSGIApplicationCreatedEvent = IApplicationCreated # b /c class IResponse(Interface): - """ Represents a WSGI response using the WebOb response interface. Some - attribute and method documentation of this interface references `RFC 2616 - `_. + """ Represents a WSGI response using the WebOb response interface. + Some attribute and method documentation of this interface references + :rfc:`2616`. This interface is most famously implemented by :class:`pyramid.response.Response` and the HTTP exception classes in -- 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 --- CHANGES.txt | 2 +- HISTORY.txt | 12 +++++++----- docs/designdefense.rst | 2 +- docs/index.rst | 4 ++-- docs/narr/hooks.rst | 2 +- docs/tutorials/wiki/definingviews.rst | 2 +- docs/tutorials/wiki2/definingviews.rst | 2 +- pyramid/request.py | 2 +- 8 files changed, 15 insertions(+), 13 deletions(-) diff --git a/CHANGES.txt b/CHANGES.txt index adf448945..e3b77dedc 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -274,7 +274,7 @@ Bug Fixes - ``pyramid.view.render_view`` was not functioning properly under Python 3.x due to a byte/unicode discrepancy. See - http://github.com/Pylons/pyramid/issues/721 + https://github.com/Pylons/pyramid/issues/721 Deprecations ------------ diff --git a/HISTORY.txt b/HISTORY.txt index f10cfa3ab..67de56998 100644 --- a/HISTORY.txt +++ b/HISTORY.txt @@ -537,7 +537,7 @@ Documentation - 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). + (http://docs.pylonsproject.org/projects/pyramid_cookbook/en/latest/deployment/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. @@ -1189,7 +1189,7 @@ Scaffolds package at all; configuration in the ``production.ini`` file which used to require its ``error_catcher`` middleware has been removed. Configuring error catching / email sending is now the domain of the ``pyramid_exclog`` - package (see http://docs.pylonsproject.org/projects/pyramid_exclog/dev/). + package (see http://docs.pylonsproject.org/projects/pyramid_exclog/en/latest/). Bug Fixes --------- @@ -2047,7 +2047,7 @@ Documentation - Moved "Using ZODB With ZEO" and "Using repoze.catalog Within Pyramid" tutorials out of core documentation and into the Pyramid Tutorials site - (http://docs.pylonsproject.org/projects/pyramid_tutorials/dev/). + (http://docs.pylonsproject.org/projects/pyramid_tutorials/en/latest/). - Changed "Cleaning up After a Request" section in the URL Dispatch chapter to use ``request.add_finished_callback`` instead of jamming an object with @@ -2249,7 +2249,8 @@ Backwards Incompatibilities Pyramid core. Handlers are now a feature of the ``pyramid_handlers`` package, which can be downloaded from PyPI. Documentation for the package should be available via - http://pylonsproject.org/projects/pyramid_handlers/dev/, which describes how + http://docs.pylonsproject.org/projects/pyramid_handlers/en/latest/, + which describes how to add a configuration statement to your ``main`` block to reobtain this method. You will also need to add an ``install_requires`` dependency upon ``pyramid_handlers`` to your ``setup.py`` file. @@ -2258,7 +2259,8 @@ Backwards Incompatibilities Pyramid core. Loading ZCML is now a feature of the ``pyramid_zcml`` package, which can be downloaded from PyPI. Documentation for the package should be available via - http://pylonsproject.org/projects/pyramid_zcml/dev/, which describes how + http://docs.pylonsproject.org/projects/pyramid_zcml/en/latest/, + which describes how to add a configuration statement to your ``main`` block to reobtain this method. You will also need to add an ``install_requires`` dependency upon ``pyramid_zcml`` to your ``setup.py`` file. diff --git a/docs/designdefense.rst b/docs/designdefense.rst index 69a921498..ffcb6c5b1 100644 --- a/docs/designdefense.rst +++ b/docs/designdefense.rst @@ -1030,7 +1030,7 @@ but its intended userbase is much the same. Many others exist. We've actually even (only as a teaching tool, not as any sort of official project) `created one using Pyramid `_ (the videos use BFG, a precursor to Pyramid, but the resulting code is `available -for Pyramid too `_). Microframeworks are +for Pyramid too `_). Microframeworks are small frameworks with one common feature: each allows its users to create a fully functional application that lives in a single Python file. 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 diff --git a/docs/narr/hooks.rst b/docs/narr/hooks.rst index f38d57e73..20cadc996 100644 --- a/docs/narr/hooks.rst +++ b/docs/narr/hooks.rst @@ -711,7 +711,7 @@ The API that must be implemented by your a class that provides The default context URL generator is available for perusal as the class :class:`pyramid.traversal.ResourceURL` in the `traversal module -`_ of the +`_ of the :term:`Pylons` GitHub Pyramid repository. See :meth:`pyramid.config.add_resource_url_adapter` for more information. diff --git a/docs/tutorials/wiki/definingviews.rst b/docs/tutorials/wiki/definingviews.rst index 4dedf4320..23ee142af 100644 --- a/docs/tutorials/wiki/definingviews.rst +++ b/docs/tutorials/wiki/definingviews.rst @@ -317,7 +317,7 @@ Our templates name a single static asset named ``pylons.css``. We don't need to create this file within our package's ``static`` directory because it was provided at the time we created the project. This file is a little too long to replicate within the body of this guide, however it is available `online -`_. +`_. This CSS file will be accessed via e.g. ``/static/pylons.css`` by virtue of the call to diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst index 0e95ca1c1..9d2f8fb7f 100644 --- a/docs/tutorials/wiki2/definingviews.rst +++ b/docs/tutorials/wiki2/definingviews.rst @@ -287,7 +287,7 @@ Our templates name a single static asset named ``pylons.css``. We don't need to create this file within our package's ``static`` directory because it was provided at the time we created the project. This file is a little too long to replicate within the body of this guide, however it is available `online -`_. +`_. This CSS file will be accessed via e.g. ``http://localhost:6543/static/pylons.css`` by virtue of the call to diff --git a/pyramid/request.py b/pyramid/request.py index 27ab337de..f9aa253ac 100644 --- a/pyramid/request.py +++ b/pyramid/request.py @@ -321,7 +321,7 @@ class Request(BaseRequest, DeprecatedRequestMethodsMixin, URLMethodsMixin, version number from which this documentation is autogenerated, but it will be the 'prevailing WebOb version' at the time of the release of this :app:`Pyramid` version. See - http://pythonpaste.org/webob/ for further information. + http://webob.org/ for further information. """ exception = None exc_info = None -- cgit v1.2.3 From 62ea1b60f18d8ac0bab2331852f9ef8bee1fad57 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sat, 16 Feb 2013 01:10:49 +0200 Subject: fix link --- docs/narr/paste.rst | 2 ++ docs/narr/startup.rst | 6 +++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/narr/paste.rst b/docs/narr/paste.rst index 86b047aec..efec1f092 100644 --- a/docs/narr/paste.rst +++ b/docs/narr/paste.rst @@ -85,6 +85,8 @@ function. This is the function called by :term:`PasteDeploy` when the ``pserve`` command is invoked against our application. It accepts a global configuration object and *returns* an instance of our application. +.. _defaults_section_of_pastedeploy_file: + ``[DEFAULTS]`` Section of a PasteDeploy ``.ini`` File ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/narr/startup.rst b/docs/narr/startup.rst index f5c741f52..3a9225032 100644 --- a/docs/narr/startup.rst +++ b/docs/narr/startup.rst @@ -77,9 +77,9 @@ Here's a high-level time-ordered overview of what happens when you press Note that the constructor function accepts a ``global_config`` argument, which is a dictionary of key/value pairs mentioned in the ``[DEFAULT]`` - section of an ``.ini`` file (if `[DEFAULT] - `__ - is present). It also accepts a ``**settings`` argument, which collects + section of an ``.ini`` file + (if :ref:`[DEFAULT] ` is present). + It also accepts a ``**settings`` argument, which collects another set of arbitrary key/value pairs. The arbitrary key/value pairs received by this function in ``**settings`` will be composed of all the key/value pairs that are present in the ``[app:main]`` section (except for -- cgit v1.2.3 From 44b651726b030c106aa5d2ff6ecdd5ba47f6c662 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sat, 16 Feb 2013 13:06:07 +0200 Subject: update link --- docs/glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/glossary.rst b/docs/glossary.rst index 9220e6b5f..2d05cde03 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -324,8 +324,8 @@ Glossary `A full-featured Python web framework `_. Pylons - `A lightweight Python web framework `_ and a - predecessor of Pyramid. + `A lightweight Python web framework `_ + and a predecessor of Pyramid. ZODB `Zope Object Database `_, a -- cgit v1.2.3 From 32c508a8d8870e877dd6d98e717e55b56457de8a Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sat, 16 Feb 2013 21:50:53 +0200 Subject: use cross-references to fix some links Also fix grammar, and add a bit of consistency regarding formatting. --- docs/narr/logging.rst | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/narr/logging.rst b/docs/narr/logging.rst index f4d1d051d..bef9d119c 100644 --- a/docs/narr/logging.rst +++ b/docs/narr/logging.rst @@ -28,19 +28,17 @@ application. In particular, the :term:`PasteDeploy` ``development.ini`` and ``production.ini`` files created when you use a scaffold include a basic configuration for the Python :mod:`logging` package. -PasteDeploy ``.ini`` files use the Python standard library `ConfigParser -format `_; this the same -format used as the Python `logging module's Configuration file format -`_. The -application-related and logging-related sections in the configuration file +PasteDeploy ``.ini`` files use the Python standard library :mod:`ConfigParser +format `; this is the same format used as the Python +:ref:`logging module's Configuration file format `. +The application-related and logging-related sections in the configuration file can coexist peacefully, and the logging-related sections in the file are used from when you run ``pserve``. The ``pserve`` command calls the :func:`pyramid.paster.setup_logging` -function, a thin wrapper around the `logging.fileConfig -`_ using the specified -ini file if it contains a ``[loggers]`` section (all of the -scaffold-generated ``.ini`` files do). ``setup_logging`` reads the +function, a thin wrapper around the :func:`logging.config.fileConfig` +using the specified ``.ini`` file if it contains a ``[loggers]`` section +(all of the scaffold-generated ``.ini`` files do). ``setup_logging`` reads the logging configuration from the ini file upon which ``pserve`` was invoked. -- cgit v1.2.3 From eb71e9ef30a0edb43129c24c56885a6c3d61a3a3 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sun, 17 Feb 2013 12:15:52 +0200 Subject: make it clear where the link goes --- docs/glossary.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/glossary.rst b/docs/glossary.rst index 2d05cde03..eedd2f34f 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -654,10 +654,9 @@ Glossary `_ used by the application may have a different value for this same "global" variable. :app:`Pyramid` uses a small number of thread local variables, as - described in :ref:`threadlocals_chapter`. See also the `threading.local - documentation - `_ for - more information. + described in :ref:`threadlocals_chapter`. + See also the :class:`stdlib documentation ` + for more information. multidict An ordered dictionary that can have multiple values for each key. Adds -- cgit v1.2.3 From 6ad5fb2a48c9a0c081eb3e2b138752bc8c4e63fb Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Mon, 18 Feb 2013 23:14:16 +0200 Subject: fix links --- docs/glossary.rst | 2 +- docs/narr/paste.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/glossary.rst b/docs/glossary.rst index eedd2f34f..d3176325f 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -342,7 +342,7 @@ Glossary library created by Ian Bicking. PasteDeploy - `PasteDeploy `_ is a library used by + `PasteDeploy `_ is a library used by :app:`Pyramid` which makes it possible to configure :term:`WSGI` components together declaratively within an ``.ini`` file. It was developed by Ian Bicking. diff --git a/docs/narr/paste.rst b/docs/narr/paste.rst index efec1f092..0b3457d1e 100644 --- a/docs/narr/paste.rst +++ b/docs/narr/paste.rst @@ -21,7 +21,7 @@ of starting, stopping, and debugging an application. This chapter is not a replacement for documentation about PasteDeploy; it only contextualizes the use of PasteDeploy within Pyramid. For detailed -documentation, see http://pythonpaste.org. +documentation, see http://pythonpaste.org/deploy/. PasteDeploy ----------- -- cgit v1.2.3 From cff8573673d919fd0fc3b283bef03923e1db54b5 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Tue, 19 Feb 2013 23:15:36 +0200 Subject: update links --- docs/designdefense.rst | 2 +- docs/glossary.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/designdefense.rst b/docs/designdefense.rst index ffcb6c5b1..749c9b099 100644 --- a/docs/designdefense.rst +++ b/docs/designdefense.rst @@ -238,7 +238,7 @@ registry API. :app:`Pyramid` framework developers were so concerned about conceptual load issues of the ZCA registry API for framework developers that a `replacement -registry implementation `_ +registry implementation `_ named :mod:`repoze.component` was actually developed. Though this package has a registry implementation which is fully functional and well-tested, and its API is much nicer than the ZCA registry API, work on it was largely diff --git a/docs/glossary.rst b/docs/glossary.rst index d3176325f..75bc126f8 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -684,7 +684,7 @@ Glossary The C implementation of the Python language. This is the reference implementation that most people refer to as simply "Python"; :term:`Jython`, Google's App Engine, and `PyPy - `_ are examples of + `_ are examples of non-C based Python implementations. View Lookup -- cgit v1.2.3 From 75ebabe886bbbe14c873e60597f16531c151a867 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Tue, 19 Feb 2013 23:26:45 +0200 Subject: fix broken link --- docs/narr/i18n.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/narr/i18n.rst b/docs/narr/i18n.rst index 511464322..24cd3ff54 100644 --- a/docs/narr/i18n.rst +++ b/docs/narr/i18n.rst @@ -736,9 +736,7 @@ through translation before being rendered: The features represented by attributes of the ``i18n`` namespace of Chameleon will also consult the :app:`Pyramid` translations. -See -`http://chameleon.repoze.org/docs/latest/i18n.html#the-i18n-namespace -`_. +See http://chameleon.readthedocs.org/en/latest/reference.html#id50. .. note:: -- cgit v1.2.3 From 9547903b00196b7311b6f0c26f42fed78a91e933 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Tue, 19 Feb 2013 23:34:56 +0200 Subject: rm broken link; could not find existing equivalent --- docs/narr/introduction.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/narr/introduction.rst b/docs/narr/introduction.rst index 3540ee5c4..47c32b0ba 100644 --- a/docs/narr/introduction.rst +++ b/docs/narr/introduction.rst @@ -219,7 +219,6 @@ that the Pyramid core doesn't. Add-on packages already exist which let you easily send email, let you use the Jinja2 templating system, let you use XML-RPC or JSON-RPC, let you integrate with jQuery Mobile, etc. -Examples: http://docs.pylonsproject.org/docs/pyramid.html#pyramid-add-on-documentation Class-based and function-based views ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3 From 8087fb7b72a8642ce3a323692b828d87369cff9f Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Tue, 19 Feb 2013 23:40:04 +0200 Subject: fix broken links --- docs/whatsnew-1.0.rst | 2 +- docs/whatsnew-1.3.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/whatsnew-1.0.rst b/docs/whatsnew-1.0.rst index 66cb9be3a..d1f3046ca 100644 --- a/docs/whatsnew-1.0.rst +++ b/docs/whatsnew-1.0.rst @@ -249,7 +249,7 @@ ZCML Externalized Pyramid core. Loading ZCML is now a feature of the :term:`pyramid_zcml` package, which can be downloaded from PyPI. Documentation for the package should be available via - http://pylonsproject.org/projects/pyramid_zcml/dev/, which describes how to + http://docs.pylonsproject.org/projects/pyramid_zcml/en/latest/, which describes how to add a configuration statement to your ``main`` block to reobtain this method. You will also need to add an ``install_requires`` dependency upon the ``pyramid_zcml`` distribution to your ``setup.py`` file. diff --git a/docs/whatsnew-1.3.rst b/docs/whatsnew-1.3.rst index f32053202..dfc7b4f4b 100644 --- a/docs/whatsnew-1.3.rst +++ b/docs/whatsnew-1.3.rst @@ -524,7 +524,7 @@ Documentation Enhancements - 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). + (http://docs.pylonsproject.org/projects/pyramid_cookbook/en/latest/deployment/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. -- cgit v1.2.3 From 5cb4fc4b08066e11505dd2cf0b2e7af93d4e7a45 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Tue, 19 Feb 2013 23:52:08 +0200 Subject: rm reference to broken link --- BFG_HISTORY.txt | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/BFG_HISTORY.txt b/BFG_HISTORY.txt index 10d926c70..3142db2b9 100644 --- a/BFG_HISTORY.txt +++ b/BFG_HISTORY.txt @@ -4609,9 +4609,7 @@ Bug Fixes To resolve this issue, the urldispatch module was fixed, and a fork of the Routes trunk was put into the "dev" index named - ``Routes-1.11dev-chrism-home``. The source for the fork exists at - `http://bitbucket.org/chrism/routes-home/ - `_; its contents have been + ``Routes-1.11dev-chrism-home``. Its contents have been merged into the Routes trunk (what will be Routes 1.11). 0.8a5 (2009-05-08) -- cgit v1.2.3 From 2d29f10e02d239745d04bf765b1c33f533c3c9b5 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Tue, 12 Mar 2013 22:45:13 +0200 Subject: we want to keep the reference alive --- BFG_HISTORY.txt | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/BFG_HISTORY.txt b/BFG_HISTORY.txt index 3142db2b9..8a2d40920 100644 --- a/BFG_HISTORY.txt +++ b/BFG_HISTORY.txt @@ -4609,8 +4609,11 @@ Bug Fixes To resolve this issue, the urldispatch module was fixed, and a fork of the Routes trunk was put into the "dev" index named - ``Routes-1.11dev-chrism-home``. Its contents have been - merged into the Routes trunk (what will be Routes 1.11). + ``Routes-1.11dev-chrism-home``. The source for the fork exists at + `http://bitbucket.org/chrism/routes-home/ + `_ (broken link); + its contents have been merged into the Routes trunk + (what will be Routes 1.11). 0.8a5 (2009-05-08) ================== -- cgit v1.2.3