Skeleton for Vector2

This moves the Vector2 documentation to the source code and uses
autoclass to generate it. There are minor language and formatting changes.

Author: Tjstretchalot

docs/Geometry.rst

@@ -59,247 +59,10 @@ Features
 Vector2
 -------
 
-.. class:: Vector2
-
-Defines a simple two-dimensional, mutable vector.
-
-.. note::
-
-    Equality is not overriden on vectors, because it is expected that 
-    vectors will be used mutably by directly modifying x and y. However, all 
-    functions on vectors are immutable (they return a copy) 
-
-.. attribute:: Vector2.x 
-
-    The first component of this vector. Mutation is allowed where appropriate.
-
-.. attribute:: Vector2.y
-
-    The second component of this vector. Mutation is allowed where appropriate.
-
-.. method:: vector2.Vector2(self, *args, **kwargs)
-
-Accepts a pair of unnamed parameters, a pair of named x, y parameters, 
-another Vector2, or a tuple with 2 numerics. Examples of each: 
-
-.. code-block:: python
-
-    from pygorithm.geometry import vector2
-    
-    # A pair of unnamed parameters
-    vec1 = vector2.Vector2(0, 5)
-    
-    # A pair of named parameters
-    vec2 = vector2.Vector2(x = 0, y = 5)
-    
-    # Another vector2
-    vec3 = vector2.Vector2(vec2)
-    
-    # A tuple with two numerics
-    vec4 = vector2.Vector2( (0, 5) )
-
-The following operations on vectors are extremely common and rarely varied, and as such have 
-operator support.
-
-.. method:: Vector2.__add__(self, other)
-
-- **other**           : `Vector2` the vector to add to this one
-- **Return Value**    : a new `Vector2` by component-based addition
-
-Adds the two vectors component wise. Example:
-
-.. code-block:: python
-
-    from pygorithm.geometry import vector2
-    
-    vec1 = vector2.Vector2(0, 3)
-    vec2 = vector2.Vector2(2, 4)
-    
-    vec3 = vec1 + vec2
-    
-    # prints <2, 7>
-    print(vec3) 
-
-.. method:: Vector2.__sub__(self, other)
-
-- **other**           : `Vector2` the vector to subtract from this one
-- **Return Value**    : a new `Vector2` by component-based subtraction
-
-Subtracts the two vectors component wise. Example:
-
-.. code-block:: python
-
-    from pygorithm.geometry import vector2
-    
-    vec1 = vector2.Vector2(5, 5)
-    vec2 = vector2.Vector2(2, 3)
-    
-    vec3 = vec1 - vec2
-    vec4 = vec2 - vec1
-    
-    # prints <3, 2>
-    print(vec3)
-    
-    # prints <2, 3>
-    print(vec4)
-    
-.. method:: Vector2.__mul__(self, scale_factor)
-.. method:: Vector2.__rmul__(self, scale_factor)
-
-- **scale_factor**    : `numeric` the factor to multiply both components by
-- **Return Value**    : a new `Vector2` by component-based multiplication
-
-Scales the vector by the specified factor. Will throw an exception if 
-scale_factor is not a numeric - it will not perform the dot product (use 
-`dot` for that) Examples: 
-
-.. code-block:: python
-
-    from pygorithm.geometry import vector2
-    
-    vec1 = vector2.Vector2(4, 8)
-    
-    vec2 = vec1 * 0.5
-    vec3 = 2 * vec2
-    
-    # prints <2, 4>
-    print(vec2)
-    
-    # prints <8, 16>
-    print(vec3)
-
-
-.. method:: Vector2.__repr__(self)
-
-- **Return Value**    : an unambiguous representation of this vector
-
-.. code-block:: python
-
-    from pygorithm.geometry import vector2
-    
-    vec = vector2.Vector2(3, 5)
-    
-    # prints vector2(x=3, y=5)
-    print(repr(vec)) 
-
-.. method:: Vector2.__str__(self)
-
-- **Return Value**    : a human-readable representation of this vector
-
-.. code-block:: python
-
-    from pygorithm.geometry import vector2
-    
-    vec = vector2.Vector2(7, 11)
-    
-    # prints <7, 11>
-    print(str(vec))
-    
-    # also prints <7, 11>
-    print(vec)
-
-.. method:: Vector2.dot(self, other)
-
-- **other**           : `vector2` to perform the dot product on
-- **Return Value**    : a numeric from the dot product of the two vectors
-
-The dot product of two vectors is calculated as so::
-
-    Let v1 be a vector such that v1 = <v1_x, v1_y>
-    Let v2 be a vector such that v2 = <v2_x, v2_y>
-    
-    v1 . v2 = v1_x * v2_x + v1_y * v2_y
-
-Example:
-
-.. code-block:: python
-
-    from pygorithm.geometry import vector2
-    
-    vec1 = vector2.Vector2(3, 5)
-    vec2 = vector2.Vector2(7, 11)
-    
-    dot_12 = vec1.dot(vec2)
-    
-    # prints 76
-    print(dot_12) 
-    
-.. method:: Vector2.rotate(self, *args, **kwargs)
-
-The named argument "degrees" or "radians" may be passed in to rotate 
-this vector by the specified amount in degrees (or radians), 
-respectively. If both are omitted, the first unnamed argument is 
-assumed to be the amount to rotate in radians. 
-
-Additionally, the named argument "about" may be passed in to specify 
-about what the vector should be rotated. If omitted then the first 
-unconsumed unnamed argument is assumed to be the vector. If there are 
-no unconsumed unnamed arguments then the origin is assumed. 
-
-Examples:
-
-.. code-block:: python
-
-    from pygorithm.geometry import vector2
-    import math
-    
-    vec1 = vector2.Vector2(1, 0)
-    
-    vec2 = vec1.rotate(math.pi * 0.25)
-    
-    # prints <0.707, 0.707>
-    print(vec2)
-    
-    vec3 = vec1.rotate(degrees = 45)
-    
-    # prints <0.707, 0.707>
-    print(vec3)
-    
-    # The following operations are all identical
-    
-    vec4 = vec1.rotate(math.pi, vector2.Vector2(1, 1))
-    vec5 = vec1.rotate(radians = math.pi, about = vector2.Vector2(1, 1))
-    vec6 = vec1.rotate(degrees = 180, about = vector2.Vector2(1, 1))
-    vec7 = vec1.rotate(vector2.Vector2(1, 1), degrees = 180)
-    
-    # prints <1, 2>
-    print(vec4)
-
-.. method:: Vector2.normalize(self)
-
-- **Return Value**    : a `Vector2` in the same direction as this one with a magnitude of 1
-
-Example:
-
-.. code-block:: python
-
-    from pygorithm.geometry import vector2
-    
-    vec1 = vector2.Vector2(2, 0)
-    
-    vec2 = vec1.normalize()
-    
-    # prints <1, 0>
-    print(vec2)
-    
-* Miscellaneous
-
-.. method:: vector2.magnitude(self)
-
-- **Return Value**    : a `numeric` magnitude of this vector
-
-Example:
-
-.. code-block:: python
-
-    from pygorithm.geometry import vector2
-    
-    vec1 = vector2.Vector2(3, 4)
-    magn = vec1.magnitude()
+.. autoclass:: pygorithm.geometry.vector2.Vector2
+    :members:
+    :special-members:
 
-    # prints 5
-    print(magn)
-
 Line2
 -----
 
@@ -399,6 +162,7 @@ Axis-Aligned Line
 
 .. autoclass:: pygorithm.geometry.axisall.AxisAlignedLine
     :members:
+    :special-members:
 
 Concave Polygon
 ---------------