This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sedona.git
The following commit(s) were added to refs/heads/master by this push:
new 145fec583e [DOCS] Add `sphinx-autobuild` dependency for docs hot
reloading (#2437)
145fec583e is described below
commit 145fec583ec1c60ad4523355b4644312cb83b43f
Author: John Bampton <[email protected]>
AuthorDate: Tue Oct 28 03:22:00 2025 +1000
[DOCS] Add `sphinx-autobuild` dependency for docs hot reloading (#2437)
---
pyproject.toml | 1 +
python/sedona/doc/Makefile | 5 ++++-
python/sedona/doc/make.bat | 8 ++++++++
3 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/pyproject.toml b/pyproject.toml
index 1cb03421d3..8b0c6be2f5 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -48,4 +48,5 @@ docs = [
"blacken-docs",
"sphinx",
"sphinx_rtd_theme",
+ "sphinx-autobuild",
]
diff --git a/python/sedona/doc/Makefile b/python/sedona/doc/Makefile
index 2d449559c2..af35267447 100644
--- a/python/sedona/doc/Makefile
+++ b/python/sedona/doc/Makefile
@@ -29,9 +29,12 @@ BUILDDIR = _build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-.PHONY: help Makefile
+.PHONY: help Makefile livehtml
# 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)
+
+livehtml:
+ sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/python/sedona/doc/make.bat b/python/sedona/doc/make.bat
index 98cfc29f04..cae58327d7 100644
--- a/python/sedona/doc/make.bat
+++ b/python/sedona/doc/make.bat
@@ -41,10 +41,18 @@ if errorlevel 9009 (
)
if "%1" == "" goto help
+REM --- Added section for 'livehtml' ---
+if "%1" == "livehtml" goto livehtml
+REM -------------------------------------
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
+:livehtml
+ REM
+ sphinx-autobuild "%SOURCEDIR%" "%BUILDDIR%" %SPHINXOPTS% %O%
+ goto end
+
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
