From 84f75c2e36d68bc3f3aa4982e9324ca3abe8435c Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Wed, 2 Mar 2022 16:31:03 +0100 Subject: [PATCH] :hammer: Update sphinx makefiles --- docs/Makefile | 18 +++++++------ docs/make.bat | 71 ++++++++++++++++++++++++++------------------------- 2 files changed, 46 insertions(+), 43 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index d0c3cbf1..20bbd709 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,12 +1,14 @@ -# Minimal makefile for Sphinx documentation -# +# Slightly extended 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 = source -BUILDDIR = build +# Sphinx options +export SPHINXOPTS = +export SPHINXBUILD = "sphinx-build" +export SOURCEDIR = "source" +export BUILDDIR = "build" + +# LaTeX builder options +export LATEXMKOPTS = +export LATEXOPTS = "-interaction=nonstopmode" # Put it first so that "make" without argument is like "make help". help: diff --git a/docs/make.bat b/docs/make.bat index 9534b018..4d165a8f 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -1,35 +1,36 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -if "%1" == "" goto help - -%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.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd +@ECHO OFF + +pushd %~dp0 + +REM Slightly extended command file for Sphinx documentation + +set SPHINXOPTS= +set SPHINXBUILD=sphinx-build +set SOURCEDIR=source +set BUILDDIR=build +set LATEXMKOPTS= +set LATEXOPTS=-interaction=nonstopmode + +if "%1" == "" goto help + +%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 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd