cookiecutter-django/{{cookiecutter.project_slug}}/docs/Makefile

37 lines
1.1 KiB
Makefile
Raw Normal View History

2019-12-28 12:26:43 +03:00
# Minimal makefile for Sphinx documentation
#
2019-12-28 12:26:43 +03:00
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
2021-11-04 00:03:47 +03:00
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = ./_build
{%- if cookiecutter.use_docker == 'y' %}
APP = /app
{%- else %}
APP = ../{{cookiecutter.project_slug}}
{% endif %}
.PHONY: help livehtml apidocs Makefile
2019-12-28 12:26:43 +03:00
# Put it first so that "make" without argument is like "make help".
help:
2021-11-04 02:41:08 +03:00
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -c .
# Build, watch and serve docs with live reload
livehtml:
sphinx-autobuild -b html
{%- if cookiecutter.use_docker == 'y' %} --host 0.0.0.0
{%- else %} --open-browser
{%- endif %} --port 7000 --watch $(APP) -c . $(SOURCEDIR) $(BUILDDIR)/html
# Outputs rst files from django application code
apidocs:
sphinx-apidoc -o $(SOURCEDIR)/api $(APP)
2019-12-28 12:26:43 +03:00
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
2021-11-04 02:41:08 +03:00
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -c .