Merge pull request #108 from AresSC2/refactor/migrate-to-cython-exten…

…sions refactor: migrate to cython extensions
AresSC2 · Feb 8, 2024 · 56e16b6 · 56e16b6
2 parents ad64ad9 + c7f3cb6
commit 56e16b6
Show file tree

Hide file tree

Showing 59 changed files with 1,515 additions and 6,822 deletions.
diff --git a/.flake8 b/.flake8
@@ -7,6 +7,7 @@ per-file-ignores =
 exclude =
     MapAnalyzer
     sc2_helper
+    cython_extensions
     tests/generate_pickle_data.py.py
     tests/test_run.py
     tests/conftest.py
diff --git a/.gitignore b/.gitignore
@@ -1,10 +1,10 @@
 # Byte-compiled / optimized / DLL files
 __pycache__/
-*.py[cod]
-*$py.class
+#*.py[cod]
+#*$py.class
 
 # C extensions
-*.so
+# *.so
 
 # Distribution / packaging
 .Python
@@ -130,6 +130,3 @@ dmypy.json
 
 # PyCharm
 .idea
-
-# cython compiled c code
-src/ares/*/*.c
diff --git a/build.py b/build.py
diff --git a/docs/api_reference/cython_extensions/combat_utils.md b/docs/api_reference/cython_extensions/combat_utils.md
diff --git a/docs/api_reference/cython_extensions/general_utils.md b/docs/api_reference/cython_extensions/general_utils.md
diff --git a/docs/api_reference/cython_extensions/geometry.md b/docs/api_reference/cython_extensions/geometry.md
diff --git a/docs/api_reference/cython_extensions/index.md b/docs/api_reference/cython_extensions/index.md
diff --git a/docs/api_reference/cython_extensions/placement_solver.md b/docs/api_reference/cython_extensions/placement_solver.md
diff --git a/docs/api_reference/cython_extensions/units_utils.md b/docs/api_reference/cython_extensions/units_utils.md
diff --git a/docs/api_reference/index.md b/docs/api_reference/index.md
@@ -7,9 +7,6 @@ Utilize the menu to delve into the available functionalities, currently organize
 
  - `Behaviors` - Discover the art of crafting personalized combat maneuvers or macro plans. 
 Each Behavior can be executed individually, tailored to your specific requirements.
- - `Cython Extensions` - Acquaint yourself with optimized functions that harness the power of cython. 
-Many of these functions exhibit multiple-fold speed enhancements compared to their Python counterparts, 
-many of which serve as alternatives to `python-sc2` functions.
  - `Manager mediator` - Seamlessly orchestrating numerous managers in the background, the mediator serves 
 as the recommended approach to access data and functions within these managers.
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -49,13 +49,6 @@ nav:
           - Individual Combat Behaviors: api_reference/behaviors/combat_behaviors.md
           - Group Combat Behaviors: api_reference/behaviors/group_combat_behaviors.md
           - Macro Behaviors: api_reference/behaviors/macro_behaviors.md
-      - Cython Extensions:
-          - api_reference/cython_extensions/index.md
-          - Combat Utils: api_reference/cython_extensions/combat_utils.md
-          - General Utils: api_reference/cython_extensions/general_utils.md
-          - Geometry: api_reference/cython_extensions/geometry.md
-          - Placement Solver: api_reference/cython_extensions/placement_solver.md
-          - Units Utils: api_reference/cython_extensions/units_utils.md
       - api_reference/manager_mediator.md
 
   - Contributing: