Wrote some doc string for a_star_navigator

SJSURoboticsTeam · Mar 24, 2024 · 74d958e · 74d958e
1 parent 85961db
commit 74d958e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml
@@ -18,7 +18,7 @@ jobs:
         path: docs/_build/html/
     - name: Deploy
       uses: peaceiris/actions-gh-pages@v3
-      if: github.ref == 'refs/heads/main'
+      if: github.ref == 'refs/heads/sphinx_docs'
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         publish_dir: docs/_build/html
diff --git a/unified_frameworks/a_star_navigator.py b/unified_frameworks/a_star_navigator.py
@@ -1,3 +1,9 @@
+"""
+This is a navigator that implementes an A* stearch in a continous space
+to find a path from the current position to the destination position
+bla bla bla
+
+"""
 import sys
 import re
 root = (next(re.finditer(".*unified_frameworks", __file__)).group())