mirror of
https://github.com/cookiecutter/cookiecutter-django.git
synced 2024-09-22 11:59:09 +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
41 lines
1.2 KiB
Makefile
41 lines
1.2 KiB
Makefile
# Minimal makefile for Sphinx documentation
|
|
#
|
|
|
|
# You can set these variables from the command line, and also
|
|
# from the environment for the first two.
|
|
SPHINXOPTS ?=
|
|
SPHINXBUILD ?= sphinx-build -c .
|
|
SOURCEDIR = ./_source
|
|
BUILDDIR = ./_build
|
|
{%- if cookiecutter.use_docker == 'y' %}
|
|
APP = /app
|
|
{%- else %}
|
|
APP = ../{{cookiecutter.project_slug}}
|
|
{% endif %}
|
|
|
|
.PHONY: help livehtml apidocs Makefile
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
help:
|
|
@$(SPHINXBUILD) help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
# Build, watch and serve docs with live reload
|
|
livehtml:
|
|
sphinx-autobuild -b html
|
|
{%- if cookiecutter.use_docker == 'y' %} -H 0.0.0.0
|
|
{%- else %} --open-browser
|
|
{%- endif %} -p 7000 --watch $(APP) -c . $(SOURCEDIR) $(BUILDDIR)/html
|
|
|
|
# Outputs rst files from django application code
|
|
apidocs:
|
|
{%- if cookiecutter.use_docker == 'y' %}
|
|
sphinx-apidoc -o $(SOURCEDIR)/api /app
|
|
{%- else %}
|
|
sphinx-apidoc -o $(SOURCEDIR)/api ../{{cookiecutter.project_slug}}
|
|
{%- endif %}
|
|
|
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
%: Makefile
|
|
@$(SPHINXBUILD) -b $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|