aboutsummaryrefslogtreecommitdiffstats
path: root/docs/make.bat
diff options
context:
space:
mode:
authorNao Pross <np@0hm.ch>2024-03-03 03:15:40 +0100
committerNao Pross <np@0hm.ch>2024-03-03 03:15:40 +0100
commit584c527bfb647ec16609bf79864292399cef54e3 (patch)
treee399a86812445dd115bc7e25d8f6330636c9f48a /docs/make.bat
parentImprove docstrings (diff)
downloadmdpoly-584c527bfb647ec16609bf79864292399cef54e3.tar.gz
mdpoly-584c527bfb647ec16609bf79864292399cef54e3.zip
Setup Sphinx documentation generator
Diffstat (limited to '')
-rw-r--r--docs/make.bat35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..32bb245
--- /dev/null
+++ b/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