Skip to content

Commit d4899df

Browse files
committed
Begin documentation for geometry
This took longer than expected, but it's the first pass at the documentation for the geometry module, which is going to be necessary to test some of the more complicated pathfinding algorithms which operate on entities of varying sizes rather than point particles. docs/Geometry.rst - Document vector2, line2, axisall, polygon2 docs/index.rst - Add geometry pygorithm/__init__.py - Add geometry pygorithm/geometry/__init__.py - Import vector2, axisall, line2, polygon2 pygorithm/geometry/axisall.py - Empty file pygorithm/geometry/line2.py - Empty file pygorithm/geometry/polygon2.py - Empty file pygorithm/geometry/vector2.py - Empty file tests/test_geometry.py - Empty file
1 parent 89d733e commit d4899df

File tree

9 files changed

+605
-0
lines changed

9 files changed

+605
-0
lines changed

docs/Geometry.rst

Lines changed: 589 additions & 0 deletions
Large diffs are not rendered by default.

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Quick Links
2828
Fibonacci
2929
Math
3030
Pathfinding
31+
Geometry
3132

3233
Quick Start Guide
3334
-----------------

pygorithm/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,5 @@
6464
'sorting',
6565
'string',
6666
'pathfinding',
67+
'geometry'
6768
]

pygorithm/geometry/__init__.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""
2+
Collection of geometry examples
3+
"""
4+
from . import vector2
5+
from . import axisall
6+
from . import line2
7+
from . import polygon2
8+
9+
__all__ = [
10+
'vector2',
11+
'axisall',
12+
'line2',
13+
'polygon2'
14+
]

pygorithm/geometry/axisall.py

Whitespace-only changes.

pygorithm/geometry/line2.py

Whitespace-only changes.

pygorithm/geometry/polygon2.py

Whitespace-only changes.

pygorithm/geometry/vector2.py

Whitespace-only changes.

tests/test_geometry.py

Whitespace-only changes.

0 commit comments

Comments
 (0)