Merge sphinx-site-657: Switch to a Sphinx site.

Author: thijs
Reviewer: nick
Fixes: #657

This completes the transition from a Trac-based site to a Sphinx documentation-based site.
All content from the wiki, that now lives on dev.pyamf.org, has been translated into .rst and old
wiki pages are now re-directing to the new RestructuredText version of the page. 

Other changes:

 - new html design for the tutorials page, instead of simple ul/li list
 - get rid of welcome to pyamf docs statement on the front page
 - fix stuff related to the current release; the download page now refers to the lastest release
   (0.5.1) and the latest source section has a link to the 0.6 whatsnew page. the whatsnew page
    reference on the homepage refers to 0.5.x, the latest release.
 - added indexes on howto/doc pages
 - fixed references to the trac site (now dev.pyamf.org)
 - added links in the menu to the trac site (creating/viewing tickets/timeline/roadmap etc).
 - added many more modules etc to the library reference and linked to them from various documents
   like the features page
 - added more documentation for the various *_MAPS in pyamf
 - added quick search


git-svn-id: https://svn.pyamf.org/pyamf/trunk@3146 2dde4cc4-cf3c-0410-b1a3-a9b8ff274da5

LICENSE.txt

@@ -4,7 +4,7 @@ MIT license is included below.
 MIT License
 ===========
 
-Copyright (c) 2007-2009 The PyAMF Project. All rights reserved.
+Copyright (c) 2007-2010 The PyAMF Project. All rights reserved.
 
 - Arnar Birgisson
 - Thijs Triemstra

README.txt

@@ -1,7 +1,7 @@
 PyAMF_ provides Action Message Format (AMF_) support for Python_ that is
 compatible with the `Adobe Flash Player`_. It includes integration with
-Python web frameworks like Pylons_, Twisted_, SQLAlchemy_, web2py_ and
-more_.
+Python web frameworks like Django_, Pylons_, Twisted_, SQLAlchemy_,
+web2py_ and more_.
 
 The `Adobe Integrated Runtime`_ and `Adobe Flash Player`_ use AMF to
 communicate between an application and a remote server. AMF encodes
@@ -28,11 +28,11 @@ ArrayCollection_, ObjectProxy_ and IExternalizable_.
 .. _Twisted:	http://twistedmatrix.com
 .. _SQLAlchemy: http://sqlalchemy.org
 .. _web2py:	http://www.web2py.com
-.. _more:	http://docs.pyamf.org/current/tutorials/index.html
+.. _more:	http://pyamf.org/tutorials/index.html
 .. _Adobe Integrated Runtime: http://en.wikipedia.org/wiki/Adobe_AIR
 .. _RTMP/RTMPS:	http://en.wikipedia.org/wiki/Real_Time_Messaging_Protocol
-.. _ActionScript: http://pyamf.org/wiki/ActionScript
-.. _ByteArray:	http://pyamf.org/wiki/ByteArray
-.. _ArrayCollection: http://pyamf.org/wiki/ArrayCollection
-.. _ObjectProxy: http://pyamf.org/wiki/ObjectProxy
-.. _IExternalizable: http://pyamf.org/wiki/IExternalizable
+.. _ActionScript: http://dev.pyamf.org/wiki/ActionScript
+.. _ByteArray:	http://dev.pyamf.org/wiki/ByteArray
+.. _ArrayCollection: http://dev.pyamf.org/wiki/ArrayCollection
+.. _ObjectProxy: http://dev.pyamf.org/wiki/ObjectProxy
+.. _IExternalizable: http://dev.pyamf.org/wiki/IExternalizable

doc/about.rst

@@ -11,7 +11,7 @@ In the online version of these documents, you can submit comments and
 suggest changes directly on the documentation pages.
 
 Development of the documentation takes place on the
-`users mailing list <http://pyamf.org/wiki/MailingList#Users>`_. We're
+:doc:`users mailing list <community/mailinglist>`. We're
 always looking for volunteers wanting to help with the docs, so feel
 free to send a mail there!
 

doc/architecture/adapters.rst

@@ -2,7 +2,6 @@
   Adapter Framework 
 *********************
 
-
 .. topic:: Introduction
 
    The Adapter Framework allows PyAMF to integrate nicely with other Python
@@ -12,17 +11,14 @@
 Adapters Overview
 =================
 
-We currently have adapters for the following packages:
-
-- `Django <http://www.djangoproject.com>`_
-- `Google App Engine <http://appengine.google.com>`_
-- `SQLAlchemy <http://www.sqlalchemy.org>`_
-- `Elixir <http://www.elixir.ematia.de/>`_
+We currently have adapters for the following libraries:
 
-And support for the stdlib:
-
-- `sets <http://www.python.org/doc/2.5.2/lib/types-set.html>`_ module
-- `decimal <http://www.python.org/doc/2.5.2/lib/module-decimal.html>`_ module
+- :doc:`../tutorials/gateways/django`
+- :doc:`../tutorials/gateways/appengine`
+- :doc:`../tutorials/gateways/sqlalchemy`
+- Elixir_
+- sets_ module
+- decimal_ module
 
 
 How It Works
@@ -31,7 +27,7 @@ How It Works
 The adapter framework works silently in the background. This means that the user
 does not need to specifically import the Django adapter module within PyAMF, it
 is all handled in the background. It works by adding a module loader and finder
-to sys.meta_path so it can intercept import calls and) to fire a callback when,
+to ``sys.meta_path`` so it can intercept import calls and) to fire a callback when,
 for example the ``django`` module is imported and accessed.
 
 It is important to note that PyAMF does not load all the modules when
@@ -75,5 +71,9 @@ And you're done!
 What next?
 ==========
 
-`Contributions <http://pyamf.org/newticket>`_ (including unit tests) are always
-welcome!
+:doc:`Contributions</bugs>` (including unit tests) are always welcome!
+
+.. _Elixir: http://www.elixir.ematia.de
+.. _sets: http://www.python.org/doc/2.5.2/lib/types-set.html
+.. _Contributions: http://pyamf.org/newticket
+.. _decimal: http://www.python.org/doc/2.5.2/lib/module-decimal.html

doc/architecture/attributecontrol.rst

@@ -2,12 +2,12 @@
   Attribute Control 
 *********************
 
-
 .. topic:: Introduction
 
    This document explains how to have more fine grain control over what
    gets encoded by PyAMF 0.5 and newer.
 
+.. contents::
 
 Control What Gets Encoded
 =========================

doc/architecture/future.rst

@@ -6,6 +6,6 @@ This is a list of stuff we want to get done before a 1.0
 release.
 
 
-- `Flex Messaging <http://pyamf.org/milestone/Flex%20Migration>`_
-- `Python 3.0 compatibility <http://pyamf.org/milestone/0.7>`_
-- `Jython support <http://pyamf.org/ticket/269>`_
+- `Flex Migration <http://dev.pyamf.org/milestone/Flex%20Migration>`_
+- `Python 3.0 compatibility <http://dev.pyamf.org/milestone/0.7>`_
+- `Jython support <http://dev.pyamf.org/ticket/269>`_

doc/architecture/overview.rst

@@ -2,28 +2,29 @@
   Features
 ============
 
-Here's a brief description of the features in PyAMF. The ``CHANGES``
-document contains a more detailed summary of all new features.
+Here's a brief description of the features in PyAMF. The
+:doc:`CHANGES <../changelog>` document contains a more detailed
+summary of all new features.
 
-- `AMF0`_ encoder/decoder for legacy Adobe Flash Players (version 6-8)
-- `AMF3`_ encoder/decoder for the new AMF format in Adobe Flash Player 9
+- :mod:`AMF0 <pyamf.amf0>` encoder/decoder for legacy Adobe Flash Players (version 6-8)
+- :mod:`AMF3 <pyamf.amf3>` encoder/decoder for the new AMF format in Adobe Flash Player 9
   and newer
 - Optional C-extension for maximum performance, created using `Cython`_
-- Support for ``IExternalizable``, ``ArrayCollection``, ``ObjectProxy``,
-  ``ByteArray``, ``RecordSet``, ``RemoteObject`` and ``more``
+- Support for ``IExternalizable``, :class:`ArrayCollection <pyamf.flex.ArrayCollection>`,
+  :class:`ObjectProxy <pyamf.flex.ObjectProxy>`, :class:`ByteArray <pyamf.amf3.ByteArray>`,
+  :class:`RecordSet <pyamf.amf0.RecordSet>`, ``RemoteObject`` and ``more``
 - Remoting gateways for :doc:`Twisted <../tutorials/gateways/twisted>`,
   :doc:`Django <../tutorials/gateways/django>`,
   :doc:`Google App Engine <../tutorials/gateways/appengine>`,
   :doc:`Pylons <../tutorials/gateways/pylons>`,
   :doc:`TurboGears2 <../tutorials/gateways/turbogears>`,
-  :doc:`web2py <../tutorials/gateways/web2py>`, and any compatible
-  `WSGI <http://wsgi.org>`_ framework
+  :doc:`web2py <../tutorials/gateways/web2py>`, and any compatible WSGI_ framework
 - :doc:`Adapter framework <../architecture/adapters>` to integrate
   nicely with third-party Python projects including
   :doc:`Django <../tutorials/gateways/django>`,
   :doc:`Google App Engine <../tutorials/gateways/appengine>` and
   :doc:`SQLAlchemy <../tutorials/gateways/sqlalchemy>`
-- ``Authentication``/``setCredentials`` support
+- :doc:`Authentication <../tutorials/general/authentication>`/``setCredentials`` support
 - Python AMF :doc:`client <../tutorials/general/client>` with HTTP(S)
   and authentication support
 - Service Browser requests supported
@@ -33,6 +34,5 @@ document contains a more detailed summary of all new features.
 Also see the our plans for :doc:`future development <future>`.
 
 
-.. _AMF0: http://livedocs.adobe.com/flex/3/langref/flash/net/ObjectEncoding.html#AMF0
-.. _AMF3: http://livedocs.adobe.com/flex/3/langref/flash/net/ObjectEncoding.html#AMF3
+.. _WSGI: http://wsgi.org
 .. _Cython: http://cython.org

doc/architecture/typemap.rst

@@ -2,8 +2,7 @@
   Type Map 
 ************
 
-
-.. topic:: Introduction
+.. topic:: Overview
 
    The following is a guide to the ActionScript to Python type
    mappings.
@@ -19,7 +18,7 @@ The following types are available in Adobe Flash Player 6 and newer:
 +=====================================+=================================+
 | ``null``          		      | ``None``    	                |
 +-------------------------------------+---------------------------------+
-| ``undefined``, ``void``             | ``pyamf.Undefined``             |
+| ``undefined``, ``void``             | :class:`pyamf.Undefined`        |
 +-------------------------------------+---------------------------------+
 | ``String``     	              | ``unicode``                     |
 +-------------------------------------+---------------------------------+
@@ -31,14 +30,14 @@ The following types are available in Adobe Flash Player 6 and newer:
 +-------------------------------------+---------------------------------+
 | ``XML``                             | ``ElementTree.Element``         |
 +-------------------------------------+---------------------------------+
-| ``Array``               	      | ``list, tuple``                 |
+| ``Array``               	      | ``list``, ``tuple``             |
 +-------------------------------------+---------------------------------+
 | ``Object``    		      |	``dict``		        |
 +-------------------------------------+---------------------------------+
-| ``RecordSet``                	      | ``pyamf.amf0.RecordSet``        |
+| ``RecordSet``                	      | :class:`pyamf.amf0.RecordSet`   |
 +-------------------------------------+---------------------------------+
 | Typed Object (other than the above) | class instance (registered via  |
-|				      | ``pyamf.register_class``)       |
+|				      | :func:`pyamf.register_class`)   |
 +-------------------------------------+---------------------------------+
 
 
@@ -52,44 +51,49 @@ The following types are available in the Adobe Flash Player 9 and newer:
 +=====================================+=================================+
 | ``int``, ``uint``          	      | ``int``    	                |
 +-------------------------------------+---------------------------------+
-| ``ByteArray``             	      | ``pyamf.amf3.ByteArray``        |
+| ``ByteArray``             	      | :class:`pyamf.amf3.ByteArray`   |
 +-------------------------------------+---------------------------------+
-| ``DataInput``     	              | ``pyamf.amf3.DataInput``        |
+| ``DataInput``     	              | :class:`pyamf.amf3.DataInput`   |
 +-------------------------------------+---------------------------------+
-| ``DataOutput``                      | ``pyamf.amf3.DataOutput``       |
+| ``DataOutput``                      | :class:`pyamf.amf3.DataOutput`  |
 +-------------------------------------+---------------------------------+
 
 
 Flex (AMF3)
 ===========
 
-The following types are available in `Adobe Flex 2
-<http://opensource.adobe.com/wiki/display/flexsdk/>`_ and newer:
-
-+-------------------------------------+---------------------------------------------+
-| ActionScript Type                   | Python Type	                            |
-+=====================================+=============================================+
-| ``ObjectProxy``          	      | ``pyamf.flex.ObjectProxy``                  |
-+-------------------------------------+---------------------------------------------+
-| ``ArrayCollection``         	      | ``pyamf.flex.ArrayCollection``              |
-+-------------------------------------+---------------------------------------------+
-| ``AbstractMessage``     	      | ``pyamf.flex.messaging.AbstractMessage``    |
-+-------------------------------------+---------------------------------------------+
-| ``AcknowledgeMessage``              | ``pyamf.flex.messaging.AcknowledgeMessage`` |
-+-------------------------------------+---------------------------------------------+
-| ``AsyncMessage``                    | ``pyamf.flex.messaging.AsyncMessage``       |
-+-------------------------------------+---------------------------------------------+
-| ``CommandMessage``                  | ``pyamf.flex.messaging.CommandMessage``     |
-+-------------------------------------+---------------------------------------------+
-| ``ErrorMessage``                    | ``pyamf.flex.messaging.ErrorMessage``       |
-+-------------------------------------+---------------------------------------------+
-| ``RemotingMessage``                 | ``pyamf.flex.messaging.RemotingMessage``    |
-+-------------------------------------+---------------------------------------------+
-| ``DataMessage``                     | ``pyamf.flex.data.DataMessage``             |
-+-------------------------------------+---------------------------------------------+
-| ``SequencedMessage``                | ``pyamf.flex.data.SequencedMessage``        |
-+-------------------------------------+---------------------------------------------+
-| ``PagedMessage``                    | ``pyamf.flex.data.PagedMessage``            |
-+-------------------------------------+---------------------------------------------+
-| ``DataErrorMessage``                | ``pyamf.flex.data.DataErrorMessage``        |
-+-------------------------------------+---------------------------------------------+
+The following types are available in `Adobe Flex 2`_ and newer:
+
++-------------------------------------+---------------------------------------------------+
+| ActionScript Type                   | Python Type	                                  |
++=====================================+===================================================+
+| ``ObjectProxy``          	      | :class:`pyamf.flex.ObjectProxy`                   |
++-------------------------------------+---------------------------------------------------+
+| ``ArrayCollection``         	      | :class:`pyamf.flex.ArrayCollection`               |
++-------------------------------------+---------------------------------------------------+
+| ``AbstractMessage``     	      | :class:`pyamf.flex.messaging.AbstractMessage`     |
++-------------------------------------+---------------------------------------------------+
+| ``AcknowledgeMessage``              | :class:`pyamf.flex.messaging.AcknowledgeMessage`  |
++-------------------------------------+---------------------------------------------------+
+| ``AsyncMessage``                    | :class:`pyamf.flex.messaging.AsyncMessage`        |
++-------------------------------------+---------------------------------------------------+
+| ``CommandMessage``                  | :class:`pyamf.flex.messaging.CommandMessage`      |
++-------------------------------------+---------------------------------------------------+
+| ``ErrorMessage``                    | :class:`pyamf.flex.messaging.ErrorMessage`        |
++-------------------------------------+---------------------------------------------------+
+| ``RemotingMessage``                 | :class:`pyamf.flex.messaging.RemotingMessage`     |
++-------------------------------------+---------------------------------------------------+
+| ``DataMessage``                     | :class:`pyamf.flex.data.DataMessage`              |
++-------------------------------------+---------------------------------------------------+
+| ``SequencedMessage``                | :class:`pyamf.flex.data.SequencedMessage`         |
++-------------------------------------+---------------------------------------------------+
+| ``PagedMessage``                    | :class:`pyamf.flex.data.PagedMessage`             |
++-------------------------------------+---------------------------------------------------+
+| ``DataErrorMessage``                | :class:`pyamf.flex.data.DataErrorMessage`         |
++-------------------------------------+---------------------------------------------------+
+
+**Note**: We plan to deprecate and move the Flex support into a new project_ before PyAMF 1.0 is released.
+
+
+.. _Adobe Flex 2: http://opensource.adobe.com/wiki/display/flexsdk
+.. _project: http://plasmads.org

doc/bugs.rst

@@ -4,9 +4,9 @@
 Reporting Bugs in PyAMF
 ***********************
 
-Bug reports should be submitted via the PyAMF Bug Tracker
-(http://pyamf.org).  The bug tracker offers a Web form which allows
-pertinent information to be entered and submitted to the developers.
+Bug reports should be submitted via the PyAMF Bug Tracker on http://dev.pyamf.org.
+The bug tracker offers a Web form which allows pertinent information to be entered
+and submitted to the developers.
 
 The first step in filing a report is to determine whether the problem has
 already been reported.  The advantage in doing so, aside from saving the
@@ -17,12 +17,14 @@ To do this, search the bug database using the search box on the top of the page.
 
 If the problem you're reporting is not already in the bug tracker, go back to
 the PyAMF Bug Tracker.  If you don't already have a tracker account, select the
-"Register" link in the navigation bar and undergo the registration procedure.
-Otherwise, if you're not logged in, enter your credentials and select "Login".
-It is not possible to submit a bug report anonymously.
-
-Being now logged in, you can submit a bug.  Select the "New Ticket" link in 
-the sidebar to open the bug reporting form.
+`Register <http://dev.pyamf.org/register>`_ link in the navigation bar and
+undergo the registration procedure. Otherwise, if you're not logged in, enter
+your credentials and select "Login". It is not possible to submit a bug report
+anonymously.
+
+Being now logged in, you can submit a bug.  Select the
+`New Ticket <http://dev.pyamf.org/newticket>`_ link in the sidebar to open the
+bug reporting form.
 
 The submission form has a number of fields.  For the "Summary" field, enter a
 *very* short description of the problem; less than ten words is good.  In the