diff options
| author | Nao Pross <np@0hm.ch> | 2024-04-29 14:12:22 +0200 |
|---|---|---|
| committer | Nao Pross <np@0hm.ch> | 2024-04-29 14:12:22 +0200 |
| commit | 6b16f20e5c965406b841790ca0d7ae56925860ac (patch) | |
| tree | 01bed1c72b1fcaa9fd0a65f36a233de6febbcdf7 /docs/make.bat | |
| parent | Add total order to MonomialIndex (diff) | |
| download | polymatrix-6b16f20e5c965406b841790ca0d7ae56925860ac.tar.gz polymatrix-6b16f20e5c965406b841790ca0d7ae56925860ac.zip | |
Add sphinx documentation generator
To generate the documentation run
$ make -C docs html
Diffstat (limited to '')
| -rw-r--r-- | docs/make.bat | 35 |
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
|