[Bf-docboard-svn] bf-manual: [7820] trunk/blender_docs: Add sphinx-autobuild to support file watching and hosting on localhost

[Aaron Carlisle]

Revision: 7820
          https://developer.blender.org/rBM7820
Author:   Blendify
Date:     2021-03-12 18:50:41 +0100 (Fri, 12 Mar 2021)
Log Message:
-----------
Add sphinx-autobuild to support file watching and hosting on localhost

Modified Paths:
--------------
    trunk/blender_docs/Makefile
    trunk/blender_docs/make.bat
    trunk/blender_docs/requirements.txt

Modified: trunk/blender_docs/Makefile
===================================================================
--- trunk/blender_docs/Makefile	2021-03-11 20:50:29 UTC (rev 7819)
+++ trunk/blender_docs/Makefile	2021-03-12 17:50:41 UTC (rev 7820)
@@ -73,6 +73,9 @@
 # End command checking
 # --------------------
 
+livehtml:
+	@QUICKY_CHAPTERS=$(QUICKY_CHAPTERS) \
+	sphinx-autobuild --open-browser "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 html: .SPHINXBUILD_EXISTS
 	@QUICKY_CHAPTERS=$(QUICKY_CHAPTERS) \
@@ -132,6 +135,7 @@
 	@echo "=============="
 	@echo "Convenience targets provided for building docs"
 	@echo ""
+	@echo "- livehtml             to auto build on file changes on host on localhost"
 	@echo "- epubpdf              to convert an epub file to pdf"
 	@echo "- readme               to make a 'readme.html' file"
 	@echo "- clean                to delete all old build files"

Modified: trunk/blender_docs/make.bat
===================================================================
--- trunk/blender_docs/make.bat	2021-03-11 20:50:29 UTC (rev 7819)
+++ trunk/blender_docs/make.bat	2021-03-12 17:50:41 UTC (rev 7820)
@@ -48,6 +48,7 @@
 	echo.==============
 	echo.Convenience targets provided for building docs
 	echo.
+	echo.- livehtml             to auto build on file changes on host on localhost
 	echo.- readme               to make a 'readme.html' file
 	echo.- clean                to delete all old build files
 	echo.
@@ -66,6 +67,12 @@
 	goto EOF
 )
 
+if "%1" == "livehtml" (
+	sphinx-autobuild --open-browser %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+	if errorlevel 1 exit /b 1
+	goto EOF
+)
+
 if "%1" == "html" (
 	:html
 	%SPHINXBUILD% -b html %SPHINXOPTS% %O% %SOURCEDIR% %BUILDDIR%/html

Modified: trunk/blender_docs/requirements.txt
===================================================================
--- trunk/blender_docs/requirements.txt	2021-03-11 20:50:29 UTC (rev 7819)
+++ trunk/blender_docs/requirements.txt	2021-03-12 17:50:41 UTC (rev 7820)
@@ -1,3 +1,5 @@
 sphinx==3.5.1
 sphinx-intl==2.0.1
 sphinx_rtd_theme==0.5.1
+
+sphinx-autobuild