Commits

Joel Rivera committed edcfc82

Fix a bunch of links in the documentaton.
Some of them has been updated to the new location
and others just reformated to rst.

Update copyright.

  • Participants
  • Parent commits 6be80d0

Comments (0)

Files changed (18)

cherrypy/__init__.py

  * Server API
  * WSGI API
 
-These API's are described in the CherryPy specification:
-https://bitbucket.org/cherrypy/cherrypy/wiki/CherryPySpec
+These API's are described in the `CherryPy specification <https://bitbucket.org/cherrypy/cherrypy/wiki/CherryPySpec>`_.
 """
 
 __version__ = "3.2.3"

cherrypy/_cperror.py

 expected responses (like 404 Not Found). Supply a filename from which the output
 will be read. The contents will be interpolated with the values %(status)s,
 %(message)s, %(traceback)s, and %(version)s using plain old Python
-`string formatting <http://www.python.org/doc/2.6.4/library/stdtypes.html#string-formatting-operations>`_.
+`string formatting <http://docs.python.org/2/library/stdtypes.html#string-formatting-operations>`_.
 
 ::
 

cherrypy/_cplogging.py

     def access(self):
         """Write to the access log (in Apache/NCSA Combined Log format).
 
-        See http://httpd.apache.org/docs/2.0/logs.html#combined for format
-        details.
-
+        See `the apache documentation <http://httpd.apache.org/docs/current/logs.html#combined>`_
+        for format details.
+        
         CherryPy calls this automatically for you. Note there are no arguments;
         it collects the data itself from
         :class:`cherrypy.request<cherrypy._cprequest.Request>`.

cherrypy/_cpreqbody.py

 
     Between the ``before_request_body`` and ``before_handler`` tools, CherryPy
     tries to process the request body (if any) by calling
-    :func:`request.body.process<cherrypy._cpreqbody.RequestBody.process`.
+    :func:`request.body.process<cherrypy._cpreqbody.RequestBody.process>`.
     This uses the ``content_type`` of the Entity to look up a suitable processor
     in :attr:`Entity.processors<cherrypy._cpreqbody.Entity.processors>`, a dict.
     If a matching processor cannot be found for the complete Content-Type,

cherrypy/_cptools.py

         When 'early', the session will be locked before reading the request
         body. This is off by default for safety reasons; for example,
         a large upload would block the session, denying an AJAX
-        progress meter (see https://bitbucket.org/cherrypy/cherrypy/issue/630).
+        progress meter (`issue <https://bitbucket.org/cherrypy/cherrypy/issue/630>`_).
 
         When 'explicit' (or any other value), you need to call
         cherrypy.session.acquire_lock() yourself before using

cherrypy/process/plugins.py

 class DropPrivileges(SimplePlugin):
     """Drop privileges. uid/gid arguments not available on Windows.
 
-    Special thanks to Gavin Baker: http://antonym.org/2005/12/dropping-privileges-in-python.html
+    Special thanks to `Gavin Baker <http://antonym.org/2005/12/dropping-privileges-in-python.html>`_ 
     """
 
     def __init__(self, bus, umask=None, uid=None, gid=None):

cherrypy/wsgiserver/ssl_pyopenssl.py

 """A library for integrating pyOpenSSL with CherryPy.
 
 The OpenSSL module must be importable for SSL functionality.
-You can obtain it from http://pyopenssl.sourceforge.net/
+You can obtain it from `here <https://launchpad.net/pyopenssl>`_.
 
 To use this module, set CherryPyWSGIServer.ssl_adapter to an instance of
 SSLAdapter. There are two ways to use SSL:

sphinx/source/appendix/cherrypyspeed.rst

 
 When people ask this question, they usually mean "how fast will my CherryPy-based application be ?".
 
-In 99% of the cases, the answer is "this depends on your actual application code, not on !CherryPy itself".
+In 99% of the cases, the answer is "this depends on your actual application code, not on CherryPy itself".
 
 The reason is that, for 99% of the real-world dynamic applications, most of the time spent to return a page will be spent in your actual application code, and the time actually spent in the CherryPy code will be negligible.
 
 For instance, a typical page that requires a few database calls to be built might take in total 200ms to be served. Out of these 200ms, about 2ms will be spent by CherryPy itself, and 198ms will be spend in your actual database calls and page rendering...
 
-So you can see that, if you want to optimize anything, you should really optimize your actual application code before you try to optimize !CherryPy
+So you can see that, if you want to optimize anything, you should really optimize your actual application code before you try to optimize CherryPy.
 
 Raw speed of the CherryPy HTTP server
 =====================================

sphinx/source/conf.py

 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.intersphinx']
-intersphinx_mapping = {'http://www.python.org/doc/2.6.4': None}
+intersphinx_mapping = {'http://docs.python.org/2/': None}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # General information about the project.
 project = u'CherryPy'
-copyright = u'2010, CherryPy Team'
+copyright = u'2013, CherryPy Team'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

sphinx/source/intro/install.rst

 Download
 --------
 
-You may download this version from http://download.cherrypy.org/cherrypy/3.2.0rc1/
+You may download this version from `here <http://download.cherrypy.org/cherrypy/3.2.3/>`_ 
 
 For other releases, browse our
-`download index <http://download.cherrypy.org/ download index>`_.
+`download index <http://download.cherrypy.org/cherrypy>`_.
 
 Windows Installation
 --------------------
 CherryPy's source code is managed using `Mercurial <http://mercurial.selenic.com/>`_,
 a source code control system written in python.
 
-You can access our Subversion repository using your favorite
-Mercurial client at https://bitbucket.org/cherrypy/cherrypy
+You can access our Mercurial repository using your favorite
+Mercurial client at `bitbucket <https://bitbucket.org/cherrypy/cherrypy>`_.
 
 For Windows users, we recommend the wonderful Mercurial
 client `TortoiseHg <http://tortoisehg.org/>`_. Users of
 other operating systems are advised to use multi-platform
-or the command line tools provided by the
-`core Mercurrial distribution <http://mercurial.selenic.com/>`_.
-RSS feeds. This web interface is located at https://bitbucket.org/cherrypy/cherrypy/src
-
-You may also browse present and past versions of CherryPy source code,
-inspect change sets, and even follow changes to specific trees/files using
- This web interface is located at https://bitbucket.org/cherrypy/cherrypy/src
-
-Usage notes
------------
+command line tools provided by the
+`core Mercurial distribution <http://mercurial.selenic.com/downloads/>`_.
 
 * To submit a patch fork the repository and submit your pull request.
-  For further information please contact us via email or IRC (see
-  http://bitbucket.org/cherrypy/cherrypy/wiki/CherryPyInvolved).
+  For further information please contact us via email or IRC
+  (see `getting involved <http://bitbucket.org/cherrypy/cherrypy/wiki/CherryPyInvolved>`_).
 
 Standalone WSGI server
 ----------------------

sphinx/source/intro/whycherrypy.rst

 7. Where to go from here?
 -------------------------
 
-Check out the :doc:`/concepts/index` and :doc:`/progguide/index` for
+Check out the :doc:`/tutorial/index` and :doc:`/progguide/index` for
 more complete documentation.
 

sphinx/source/progguide/REST.rst

 Within the CherryPy server, the remainder of the hierarchical
 identifier--the path--is mapped to Python objects
 via the Dispatch mechanism. This behavior is highly
-customizable and documented in :doc:`/concepts/dispatching`.
+customizable and documented in :doc:`/tutorial/dispatching`.
 
 Using the default dispatcher and page handlers, the path of the URI
 maps to a hierarchy of Python identifiers in the CherryPy app. For

sphinx/source/progguide/extending/customtools.rst

 path, a certain class, or even individual methods using the 
 :ref:`_cp_config <cp_config>` dictionary. Tools can also be used as decorators
 which provide syntactic sugar for configuring a tool for a specific callable.
-See :doc:`/concepts/tools` for more information on how to use Tools.
+See :doc:`/tutorial/tools` for more information on how to use Tools.
 This document will show you how to make your own.
 
 Your First Custom Tool

sphinx/source/refman/_cptools.rst

 :mod:`cherrypy._cptools`
 ************************
 
-See :doc:`/concepts/tools` for a conceptual overview of CherryPy Tools.
+See :doc:`/tutorial/tools` for a conceptual overview of CherryPy Tools.
 
 .. automodule:: cherrypy._cptools
 

sphinx/source/tutorial/basics.rst

 
  * :class:`cherrypy.engine <cherrypy.process.wspbus.Bus>`
    controls process startup, shutdown, and other events, including your own
-   Plugins. See :doc:`/concepts/engine`.
+   Plugins. See :doc:`/tutorial/engine`.
  * :class:`cherrypy.server <cherrypy._cpserver.Server>` configures and controls
    the HTTP server.
  * :class:`cherrypy.request <cherrypy._cprequest.Request>` contains all

sphinx/source/tutorial/config.rst

 
 .. note::
 
-   when you do an :class:`InternalRedirect<cherrypy._cperror.InternalRedirect`,
+   when you do an :class:`InternalRedirect<cherrypy._cperror.InternalRedirect>`,
    this config attribute is recalculated for the new path.
 
 Declaration
 ^^^^^
 
 Enables and configures additional request-processing packages. See the
-:doc:`/concepts/tools` overview for more information.
+:doc:`/tutorial/tools` overview for more information.
 
 wsgi
 ^^^^

sphinx/source/tutorial/dispatching.rst

 -----------------------
 
 The handler that's going to be called during a request is available at
-:attr:`cherrypy.request.handler <cherrypy._cprequest.Request.handler`,
+:attr:`cherrypy.request.handler <cherrypy._cprequest.Request.handler>`,
 which means your code has a chance to replace it before the handler runs.
 It's a snap to write a Tool to do so with a
 :class:`HandlerWrapperTool <cherrypy._cptools.HandlerWrapperTool>`::

sphinx/source/tutorial/index.rst

 
 As stated above, this is not a guide to the Python language. There are plenty of
 good resources for those learning Python (just to name a few among the best:
-`Python course in Bioinformatics <http://www.pasteur.fr/recherche/unites/sis/formation/python/>`_,
-`A Byte Of Python <http://www.byteofpython.info/>`_ and
-`Dive into Python <http://www.diveintopython.org/>`_).
+`Learn Python The Hard Way <http://learnpythonthehardway.org/>`_, 
+`A Byte Of Python <http://swaroopch.com/notes/python/>`_ and
+`Dive into Python <http://www.diveintopython.net/>`_).
 The `official Python website <http://www.python.org>`_ lists some good
 resources, including an excellent
 `tutorial <http://docs.python.org/tut/tut.html>`_.