Added help command to sphinx Makefile

This commit is contained in:
Matthew Foster Walsh 2025-09-08 19:47:18 -06:00
parent 1a5f4b9a4a
commit 8c50c6a5eb
No known key found for this signature in database
2 changed files with 6 additions and 6 deletions

View File

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

View File

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