diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..e37aa77 --- /dev/null +++ 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 index 62fd362..7a7d96d 100644 --- 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 index c0cbc31..943c1f2 100644 --- 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 -----------------------------------