Merge pull request #7 from harisankar95/update-docs

updated rst files for sphinx
harisankar95 · Jan 21, 2024 · b553453 · b553453
2 parents a5e8f93 + f7d409c
commit b553453
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,4 @@
+# Generate HTML documentation with Sphinx
+docs-html:
+	sphinx-apidoc -M -o docs/ pathfinding3d/
+	sphinx-build -b html docs docs/_build
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,7 +17,7 @@
 
 
 project = "pathfinding3d"
-copyright = "2023, Harisankar Babu"
+copyright = "2024, Harisankar Babu"
 author = "Harisankar Babu"
 release = __version__
 version = __version__

diff --git a/docs/pathfinding3d.core.rst b/docs/pathfinding3d.core.rst
@@ -25,6 +25,14 @@ pathfinding3d.core.grid module
    :undoc-members:
    :show-inheritance:
 
+pathfinding3d.core.heap module
+------------------------------
+
+.. automodule:: pathfinding3d.core.heap
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 pathfinding3d.core.heuristic module
 -----------------------------------