mirror of
https://github.com/cookiecutter/cookiecutter-django.git
synced 2024-09-21 19:39:08 +03:00
3152bdaeb3
-serve, watch + live reload for docs + code file changes -update project makefile + make.bat -separate _source and _build -add packages and paths to use autodoc -edit/add documentation with examples (both at django-cookiecutter and inside generated project) -add formatted comments in User model for pickup by Sphinx apidoc -serve docs from a separate docs container for docker build
47 lines
1.0 KiB
Batchfile
47 lines
1.0 KiB
Batchfile
@ECHO OFF
|
|
|
|
pushd %~dp0
|
|
|
|
REM Command file for Sphinx documentation
|
|
|
|
|
|
if "%SPHINXBUILD%" == "" (
|
|
set SPHINXBUILD=sphinx-build -c .
|
|
)
|
|
set SOURCEDIR=_source
|
|
set BUILDDIR=_build
|
|
set APP=..\{{cookiecutter.project_slug}}
|
|
|
|
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.Install sphinx-autobuild for live serving.
|
|
echo.If you don't have Sphinx installed, grab it from
|
|
echo.http://sphinx-doc.org/
|
|
exit /b 1
|
|
)
|
|
|
|
%SPHINXBUILD% -b %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
goto end
|
|
|
|
:livehtml
|
|
sphinx-autobuild -b html --open-browser -p 7000 --watch %APP% -c . %SOURCEDIR% %BUILDDIR%/html
|
|
GOTO :EOF
|
|
|
|
:apidocs
|
|
sphinx-apidoc -o %SOURCEDIR%/api %APP%
|
|
GOTO :EOF
|
|
|
|
:help
|
|
%SPHINXBUILD% -b help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
|
|
:end
|
|
popd
|