Merge pull request #5347 from ljfp/sphinx-makefile-fix

Fix Makefile and make.bat files used for automatic generation of documentation.
cookiecutter · Sep 23, 2024 · 2b37524 · 2b37524
2 parents eb67667 + c44f6f6
commit 2b37524
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/{{cookiecutter.project_slug}}/docs/Makefile b/{{cookiecutter.project_slug}}/docs/Makefile
@@ -13,11 +13,11 @@ APP = /app
 APP = ../{{cookiecutter.project_slug}}
 {% endif %}
 
-.PHONY: help livehtml apidocs Makefile
+.PHONY: html livehtml apidocs Makefile
 
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -c .
+# Put it first so that "make" without argument is like "make html".
+html:
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -c .
 
 # Build, watch and serve docs with live reload
 livehtml:

diff --git a/{{cookiecutter.project_slug}}/docs/make.bat b/{{cookiecutter.project_slug}}/docs/make.bat
@@ -12,7 +12,7 @@ set SOURCEDIR=_source
 set BUILDDIR=_build
 set APP=..\{{cookiecutter.project_slug}}
 
-if "%1" == "" goto help
+if "%1" == "" goto html
 
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
@@ -39,8 +39,8 @@ GOTO :EOF
 sphinx-apidoc -o %SOURCEDIR%/api %APP%
 GOTO :EOF
 
-:help
-%SPHINXBUILD% -b help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+:html
+%SPHINXBUILD% -b html %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 
 :end
 popd