Fixes for pyastar2d dependency and documentation

Author: bluemellophone

.gitignore

@@ -19,3 +19,5 @@ docs/_build/
 example*.jpg
 example*.json
 .vscode/*
+
+assets/*.key

.readthedocs.yaml

@@ -18,6 +18,6 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: requirements.txt
+   - requirements: requirements/documentation.txt
    - method: pip
      path: .

README.rst

@@ -1,4 +1,3 @@
-==============
 Kitware BatBot
 ==============
 

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -1,29 +1,17 @@
 # Configuration file for the Sphinx documentation builder.
 #
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
+# For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-
-
 # -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'Kitware BatBot'
-copyright = '2025'
-author = 'Kitware'
-
+project = 'batbot'
+copyright = '2026, Kitware, Inc.'
+author = 'Kitware, Inc.'
 
 # -- General configuration ---------------------------------------------------
-# -- General configuration
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
     'sphinx.ext.duration',
@@ -49,22 +37,13 @@
 intersphinx_disabled_domains = ['std']
 
 templates_path = ['_templates']
-
-# -- Options for EPUB output
 epub_show_urls = 'footnote'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-autosectionlabel_prefix_document = True
-
 # -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
 html_theme = 'sphinx_rtd_theme'
 
 html_theme_path = [
@@ -80,10 +59,6 @@
         'donate.html',
     ]
 }
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 html_css_files = [
     'theme.css',

docs/index.rst

@@ -1,16 +1,30 @@
+.. batbot documentation master file, created by
+   sphinx-quickstart on Thu Feb  5 13:49:59 2026.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
 .. include:: ../README.rst
 
 .. include:: ../CHANGELOG.rst
 
 .. include:: ../ISSUES.rst
 
-========
 Contents
-========
+--------
 
 .. toctree::
    :maxdepth: 3
+   :caption: Contents:
 
    Home <self>
    batbot
    cli
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+.. include:: colors.rst

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

requirements/documentation.txt

@@ -0,0 +1,4 @@
+Sphinx>=5,<6
+sphinx_click
+sphinx_rtd_theme
+standard-imghdr

requirements/optional.txt

@@ -20,8 +20,6 @@ pyupgrade
 pyyaml
 rstcheck
 rstcheck[sphinx]
-Sphinx>=5,<6
-sphinx_rtd_theme
 # torch
 # torchvision
 xdoctest

requirements/runtime.txt

@@ -8,9 +8,8 @@ numpy
 opencv-python-headless
 Pillow
 pooch
-pyastar2d @ git+https://github.com/bluemellophone/batbot-pyastar2d@master
+pyastar2d>=1.1.1
 rich
 scikit-image
 shapely
-sphinx-click
 tqdm