cookiecutter/cookiecutter-django
1
1
Fork 0
mirror of https://github.com/cookiecutter/cookiecutter-django.git synced 2024-11-22 01:26:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix Makefile and make.bat files for doc generation using sphinx-build. They were using a non-existent Builder called "help". I changed it to "html" since that is the one used by sphinx-autobuild.

Browse Source
This commit is contained in:
LJFP 2024-09-05 10:02:48 +02:00
parent d4030f123a
commit c44f6f6372
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
{{cookiecutter.project_slug}}/docs/Makefile
View File

@ -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:

6
{{cookiecutter.project_slug}}/docs/make.bat
View File

@ -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