improved documentation.

Author: [email protected]

README.txt

@@ -10,7 +10,7 @@ nice 2d physics library Chipmunk.
 This release is based on the latest pymunk release (3.0.0), 
 using chipmunk 6.1.1 (source included)
 
-:Homepage: http://code.google.com/p/pymunk/
+:Homepage: http://pymunk.org
 :Forum: http://chipmunk-physics.net/forum/
 :Email: [email protected]
 

THANKS.txt

@@ -9,7 +9,7 @@ BIG THANKS TO (in no order):
 - mr Chipmunk himself, Scott Lembcke! (Chipmunk)
 
 
-and everyone else that have conrtibuted in any way.
+and everyone else that have contributed in any way.
 
 (are you missing? contact me add I will add you)
 

docs/html/.doctrees/environment.pickle

@@ -38,7 +38,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li><a href="../index.html">pymunk 3.0.0 documentation</a> &raquo;</li> 
+    
+        <li><a href="../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+ 
       </ul>
     </div>  
 
@@ -68,7 +73,7 @@ <h3><a href="../index.html">Table Of Contents</a></h3>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../readme.html">Readme</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../news.html">News</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../installation.html">Download &amp; Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../pymunk.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Tutorials</a></li>
@@ -104,7 +109,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li><a href="../index.html">pymunk 3.0.0 documentation</a> &raquo;</li> 
+    
+        <li><a href="../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+ 
       </ul>
     </div>
     <div class="footer">

docs/html/.doctrees/installation.doctree

@@ -39,7 +39,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+    
         <li><a href="../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+
           <li><a href="index.html" accesskey="U">Module code</a> &raquo;</li> 
       </ul>
     </div>  
@@ -77,7 +82,17 @@ <h1>Source code for pymunk</h1><pre>
 pymunk is a easy-to-use pythonic 2d physics library that can be used whenever 
 you need 2d rigid body physics from Python.
 
-Homepage: http://code.google.com/p/pymunk/
+Homepage: http://pymunk.org
+
+This is the main containing module of pymunk. It contains among other things 
+the very central Space, Body and Shape classes.
+
+When you import this module it will automatically load the chipmunk library 
+file. As long as you haven't turned off the debug mode a print will show 
+exactly which Chipmunk library file it loaded. For example::
+
+    &gt;&gt;&gt; import pymunk
+    Loading chipmunk for Windows (32bit) [C:\code\pymunk\\trunk\pymunk\chipmunk.dll]
 
 """
 __version__ = "$Id: __init__.py 431 2012-08-27 22:03:19Z [email protected] $"
@@ -1632,7 +1647,7 @@ <h3><a href="../index.html">Table Of Contents</a></h3>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../readme.html">Readme</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../news.html">News</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../installation.html">Download &amp; Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../pymunk.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Tutorials</a></li>
@@ -1668,7 +1683,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+    
         <li><a href="../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+
           <li><a href="index.html" >Module code</a> &raquo;</li> 
       </ul>
     </div>

docs/html/.doctrees/news.doctree

@@ -39,7 +39,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+    
         <li><a href="../../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+
           <li><a href="../index.html" >Module code</a> &raquo;</li>
           <li><a href="../pymunk.html" accesskey="U">pymunk</a> &raquo;</li> 
       </ul>
@@ -79,8 +84,10 @@ <h1>Source code for pymunk.constraint</h1><pre>
 joints that allow bodies to pivot around each other like the bones in your 
 body, or they can be more abstract like the gear joint or motors. 
 
-Chipmunk has a good overview of the different joints on youtube which works 
-fine to showcase them in pymunk as well. 
+This submodule contain all the constraints that are supported by pymunk.
+
+Chipmunk has a good overview of the different constraint on youtube which 
+works fine to showcase them in pymunk as well. 
 http://www.youtube.com/watch?v=ZgJJZTS0aMM
 
 .. raw:: html
@@ -530,7 +537,7 @@ <h3><a href="../../index.html">Table Of Contents</a></h3>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../readme.html">Readme</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../news.html">News</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Download &amp; Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../pymunk.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../tutorials.html">Tutorials</a></li>
@@ -566,7 +573,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+    
         <li><a href="../../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+
           <li><a href="../index.html" >Module code</a> &raquo;</li>
           <li><a href="../pymunk.html" >pymunk</a> &raquo;</li> 
       </ul>

docs/html/.doctrees/pymunk.constraint.doctree

@@ -39,7 +39,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+    
         <li><a href="../../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+
           <li><a href="../index.html" >Module code</a> &raquo;</li>
           <li><a href="../pymunk.html" accesskey="U">pymunk</a> &raquo;</li> 
       </ul>
@@ -74,7 +79,8 @@ <h1>Source code for pymunk.pygame_util</h1><pre>
 # SOFTWARE.
 # ----------------------------------------------------------------------------
 
-"""Contains helper functions to help using pygame with pymunk.
+"""This submodule contains helper functions to help with quick prototyping 
+using pymunk together with pygame.
 
 Intended to help with debugging and prototyping, not for actual production use
 in a full application. The methods contained in this module is opinionated 
@@ -299,7 +305,7 @@ <h3><a href="../../index.html">Table Of Contents</a></h3>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../readme.html">Readme</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../news.html">News</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Download &amp; Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../pymunk.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../tutorials.html">Tutorials</a></li>
@@ -335,7 +341,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+    
         <li><a href="../../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+
           <li><a href="../index.html" >Module code</a> &raquo;</li>
           <li><a href="../pymunk.html" >pymunk</a> &raquo;</li> 
       </ul>

docs/html/.doctrees/pymunk.doctree

@@ -39,7 +39,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+    
         <li><a href="../../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+
           <li><a href="../index.html" >Module code</a> &raquo;</li>
           <li><a href="../pymunk.html" accesskey="U">pymunk</a> &raquo;</li> 
       </ul>
@@ -74,7 +79,10 @@ <h1>Source code for pymunk.util</h1><pre>
 # SOFTWARE.
 # ----------------------------------------------------------------------------
 
-"""Contains utility functions, mainly to help with polygon creation"""
+"""This submodule contains utility functions, mainly to help with polygon 
+creation.
+
+"""
 from __future__ import division
 __version__ = "$Id: util.py 324 2011-05-01 15:40:39Z [email protected] $"
 __docformat__ = "reStructuredText"
@@ -457,7 +465,7 @@ <h3><a href="../../index.html">Table Of Contents</a></h3>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../readme.html">Readme</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../news.html">News</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Download &amp; Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../pymunk.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../tutorials.html">Tutorials</a></li>
@@ -493,7 +501,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+    
         <li><a href="../../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+
           <li><a href="../index.html" >Module code</a> &raquo;</li>
           <li><a href="../pymunk.html" >pymunk</a> &raquo;</li> 
       </ul>

docs/html/.doctrees/pymunk.pygame_util.doctree

@@ -39,7 +39,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+    
         <li><a href="../../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+
           <li><a href="../index.html" >Module code</a> &raquo;</li>
           <li><a href="../pymunk.html" accesskey="U">pymunk</a> &raquo;</li> 
       </ul>
@@ -74,6 +79,26 @@ <h1>Source code for pymunk.vec2d</h1><pre>
 # SOFTWARE.
 # ----------------------------------------------------------------------------
 
+"""This module contain the Vec2d class that is used in all of pymunk when a 
+vector is needed.
+
+The Vec2d class is used almost everywhere in pymunk for 2d coordinates and 
+vectors, for example to define gravity vector in a space. However, pymunk is 
+smart enough to convert tuples or tuple like objects to Vec2ds so you usually 
+do not need to explcitily do conversions if you happen to have a tuple::
+
+    &gt;&gt;&gt; import pymunk
+    &gt;&gt;&gt; space = pymunk.Space()
+    &gt;&gt;&gt; print space.gravity
+    Vec2d(0.0, 0.0)
+    &gt;&gt;&gt; space.gravity = 3,5
+    &gt;&gt;&gt; print space.gravity
+    Vec2d(3.0, 5.0)
+    &gt;&gt;&gt; space.gravity += 2,6
+    &gt;&gt;&gt; print space.gravity
+    Vec2d(5.0, 11.0)
+
+"""
 __version__ = "$Id: vec2d.py 418 2012-08-20 21:42:37Z [email protected] $"
 __docformat__ = "reStructuredText"
 
@@ -86,9 +111,9 @@ <h1>Source code for pymunk.vec2d</h1><pre>
 __all__ = ["Vec2d"]
 
 <div class="viewcode-block" id="Vec2d"><a class="viewcode-back" href="../../pymunk.vec2d.html#pymunk.vec2d.Vec2d">[docs]</a>class Vec2d(ctypes.Structure):
-    """2d vector class, supports vector and scalar operators,
-       and also provides some high level functions
-       """
+    """2d vector class, supports vector and scalar operators, and also 
+    provides some high level functions.
+    """
     __slots__ = ['x', 'y']
 
     @classmethod
@@ -547,7 +572,7 @@ <h3><a href="../../index.html">Table Of Contents</a></h3>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../readme.html">Readme</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../news.html">News</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Download &amp; Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../pymunk.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../tutorials.html">Tutorials</a></li>
@@ -583,7 +608,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+    
         <li><a href="../../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+
           <li><a href="../index.html" >Module code</a> &raquo;</li>
           <li><a href="../pymunk.html" >pymunk</a> &raquo;</li> 
       </ul>

docs/html/.doctrees/pymunk.util.doctree

@@ -39,7 +39,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+    
         <li><a href="../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+
           <li><a href="index.html" accesskey="U">Module code</a> &raquo;</li> 
       </ul>
     </div>  
@@ -97,11 +102,6 @@ <h1>Source code for pymunkoptions</h1><pre>
 
     #..continue to use pymunk as you normally do
 
-The only available currently available option is
-debug
-
-    Print out useful debug information about where pymunk tries to load 
-    the chipmunk library from.
 """
 </pre>
 
@@ -117,7 +117,7 @@ <h3><a href="../index.html">Table Of Contents</a></h3>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../readme.html">Readme</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../news.html">News</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../installation.html">Download &amp; Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../pymunk.html">API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Tutorials</a></li>
@@ -153,7 +153,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+    
         <li><a href="../index.html">pymunk 3.0.0 documentation</a> &raquo;</li>
+    
+    <script type="text/javascript" src='_static/pymunk.js'></script>
+    
+
           <li><a href="index.html" >Module code</a> &raquo;</li> 
       </ul>
     </div>

docs/html/.doctrees/pymunk.vec2d.doctree

@@ -1,8 +1,9 @@
-Download & Installation
-=======================
+Installation
+============
 
 .. tip::
-    You will find the latest version at http://code.google.com/p/pymunk/
+    You will find the latest version at 
+    http://code.google.com/p/pymunk/downloads/list
 
 pymunk does not need to be installed. However, you might need to compile the 
 chipmunk library that pymunk uses internally if a precompiled library was not 

docs/html/.doctrees/pymunkoptions.doctree

@@ -31,10 +31,11 @@ Changes
 - New draw module to help with pygame prototyping
 - New pymunkoptions module to allow disable of debug
 - Tested on OSX, includes a compiled dylib file
-- Much extended and reworked documentation
+- Much extended and reworked documentation and homepage
 - Update of Chipmunk
 - Smaller API changes
 - General polish and cleanup
+- Shining new domain: pymunk.org
 
 I hope you will like it!