updated sphinx docs

harisankar95 · Jan 28, 2024 · d10be27 · d10be27
1 parent b20af8b
commit d10be27
Show file tree

Hide file tree

Showing 19 changed files with 135 additions and 119 deletions.
diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
 # Generate HTML documentation with Sphinx
 docs-html:
-	sphinx-apidoc -M -o docs/ pathfinding3d/
+	sphinx-apidoc -f -e -M -o docs/ pathfinding3d/
 	sphinx-build -b html docs docs/_build
 	cp -r docs/additional_resources/* docs/_build/
diff --git a/docs/pathfinding3d.core.diagonal_movement.rst b/docs/pathfinding3d.core.diagonal_movement.rst
@@ -0,0 +1,7 @@
+pathfinding3d.core.diagonal\_movement module
+============================================
+
+.. automodule:: pathfinding3d.core.diagonal_movement
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.core.grid.rst b/docs/pathfinding3d.core.grid.rst
@@ -0,0 +1,7 @@
+pathfinding3d.core.grid module
+==============================
+
+.. automodule:: pathfinding3d.core.grid
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.core.heap.rst b/docs/pathfinding3d.core.heap.rst
@@ -0,0 +1,7 @@
+pathfinding3d.core.heap module
+==============================
+
+.. automodule:: pathfinding3d.core.heap
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.core.heuristic.rst b/docs/pathfinding3d.core.heuristic.rst
@@ -0,0 +1,7 @@
+pathfinding3d.core.heuristic module
+===================================
+
+.. automodule:: pathfinding3d.core.heuristic
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.core.node.rst b/docs/pathfinding3d.core.node.rst
@@ -0,0 +1,7 @@
+pathfinding3d.core.node module
+==============================
+
+.. automodule:: pathfinding3d.core.node
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.core.rst b/docs/pathfinding3d.core.rst
@@ -9,58 +9,13 @@ pathfinding3d.core package
 Submodules
 ----------
 
-pathfinding3d.core.diagonal\_movement module
---------------------------------------------
-
-.. automodule:: pathfinding3d.core.diagonal_movement
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pathfinding3d.core.grid module
-------------------------------
-
-.. automodule:: pathfinding3d.core.grid
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pathfinding3d.core.heap module
-------------------------------
-
-.. automodule:: pathfinding3d.core.heap
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pathfinding3d.core.heuristic module
------------------------------------
-
-.. automodule:: pathfinding3d.core.heuristic
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pathfinding3d.core.node module
-------------------------------
-
-.. automodule:: pathfinding3d.core.node
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pathfinding3d.core.util module
-------------------------------
-
-.. automodule:: pathfinding3d.core.util
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pathfinding3d.core.world module
--------------------------------
-
-.. automodule:: pathfinding3d.core.world
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. toctree::
+   :maxdepth: 4
+
+   pathfinding3d.core.diagonal_movement
+   pathfinding3d.core.grid
+   pathfinding3d.core.heap
+   pathfinding3d.core.heuristic
+   pathfinding3d.core.node
+   pathfinding3d.core.util
+   pathfinding3d.core.world
diff --git a/docs/pathfinding3d.core.util.rst b/docs/pathfinding3d.core.util.rst
@@ -0,0 +1,7 @@
+pathfinding3d.core.util module
+==============================
+
+.. automodule:: pathfinding3d.core.util
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.core.world.rst b/docs/pathfinding3d.core.world.rst
@@ -0,0 +1,7 @@
+pathfinding3d.core.world module
+===============================
+
+.. automodule:: pathfinding3d.core.world
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.finder.a_star.rst b/docs/pathfinding3d.finder.a_star.rst
@@ -0,0 +1,7 @@
+pathfinding3d.finder.a\_star module
+===================================
+
+.. automodule:: pathfinding3d.finder.a_star
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.finder.best_first.rst b/docs/pathfinding3d.finder.best_first.rst
@@ -0,0 +1,7 @@
+pathfinding3d.finder.best\_first module
+=======================================
+
+.. automodule:: pathfinding3d.finder.best_first
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.finder.bi_a_star.rst b/docs/pathfinding3d.finder.bi_a_star.rst
@@ -0,0 +1,7 @@
+pathfinding3d.finder.bi\_a\_star module
+=======================================
+
+.. automodule:: pathfinding3d.finder.bi_a_star
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.finder.breadth_first.rst b/docs/pathfinding3d.finder.breadth_first.rst
@@ -0,0 +1,7 @@
+pathfinding3d.finder.breadth\_first module
+==========================================
+
+.. automodule:: pathfinding3d.finder.breadth_first
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.finder.dijkstra.rst b/docs/pathfinding3d.finder.dijkstra.rst
@@ -0,0 +1,7 @@
+pathfinding3d.finder.dijkstra module
+====================================
+
+.. automodule:: pathfinding3d.finder.dijkstra
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.finder.finder.rst b/docs/pathfinding3d.finder.finder.rst
@@ -0,0 +1,7 @@
+pathfinding3d.finder.finder module
+==================================
+
+.. automodule:: pathfinding3d.finder.finder
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.finder.ida_star.rst b/docs/pathfinding3d.finder.ida_star.rst
@@ -0,0 +1,7 @@
+pathfinding3d.finder.ida\_star module
+=====================================
+
+.. automodule:: pathfinding3d.finder.ida_star
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.finder.msp.rst b/docs/pathfinding3d.finder.msp.rst
@@ -0,0 +1,7 @@
+pathfinding3d.finder.msp module
+===============================
+
+.. automodule:: pathfinding3d.finder.msp
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pathfinding3d.finder.rst b/docs/pathfinding3d.finder.rst
@@ -9,66 +9,15 @@ pathfinding3d.finder package
 Submodules
 ----------
 
-pathfinding3d.finder.a\_star module
------------------------------------
-
-.. automodule:: pathfinding3d.finder.a_star
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pathfinding3d.finder.best\_first module
----------------------------------------
-
-.. automodule:: pathfinding3d.finder.best_first
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pathfinding3d.finder.bi\_a\_star module
----------------------------------------
-
-.. automodule:: pathfinding3d.finder.bi_a_star
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pathfinding3d.finder.breadth\_first module
-------------------------------------------
-
-.. automodule:: pathfinding3d.finder.breadth_first
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pathfinding3d.finder.dijkstra module
-------------------------------------
-
-.. automodule:: pathfinding3d.finder.dijkstra
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pathfinding3d.finder.finder module
-----------------------------------
-
-.. automodule:: pathfinding3d.finder.finder
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pathfinding3d.finder.ida\_star module
--------------------------------------
-
-.. automodule:: pathfinding3d.finder.ida_star
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-pathfinding3d.finder.msp module
--------------------------------
-
-.. automodule:: pathfinding3d.finder.msp
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. toctree::
+   :maxdepth: 4
+
+   pathfinding3d.finder.a_star
+   pathfinding3d.finder.best_first
+   pathfinding3d.finder.bi_a_star
+   pathfinding3d.finder.breadth_first
+   pathfinding3d.finder.dijkstra
+   pathfinding3d.finder.finder
+   pathfinding3d.finder.ida_star
+   pathfinding3d.finder.msp
+   pathfinding3d.finder.theta_star
diff --git a/docs/pathfinding3d.finder.theta_star.rst b/docs/pathfinding3d.finder.theta_star.rst
@@ -0,0 +1,7 @@
+pathfinding3d.finder.theta\_star module
+=======================================
+
+.. automodule:: pathfinding3d.finder.theta_star
+   :members:
+   :undoc-members:
+   :show-inheritance: