7.8. Makefile_docx¶
The Makefile implements a execution wrapper wrapper for the creation of the documents. Similar to Makefile. The curent final default call is:
sphinx-build
7.8.7. Source¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 | #
# AUTHOR = Arno-Can Uestuensoez
# AUTHOR_EMAIL = acue_sf2@sourceforge.net
# LICENSE = Artistic-License-2.0 + Forced-Fairplay-Constraints
# COPYRIGHT = Copyright (C) 2019 Arno-Can Uestuensoez @Ingenieurbuero Arno-Can Uestuensoez
# UUID = 1ba7bffb-c00b-4691-a3e9-e392f968e437
#
#
# *** verified for GNU-Make ***
#
#
# the build tool
#
ifdef $$BUILDDIR
BUILDDOC = $${BUILDDOC}
else
BUILDDOC = sphinx-build
endif
#
# optional comand line parameters - for test only
#
BUILDDOCOPTS = $${BUILDDOCOPTS}
ifdef ${1}
DOCTYPE = ${1}
else
ifdef $$DOCTYPE
DOCTYPE = $${DOCTYPE}
else
DOCTYPE = html
endif
endif
.PHONY: help help-sphinx Makefile clean
# standard target defined by command line or environment parameter
${DOCTYPE}: Makefile
@$(BUILDDOC) -M $@ "." "_build" $(BUILDDOCOPTS)
# alternative sildcard-target for anything else - whatsoever
%: Makefile
@$(BUILDDOC) -M $@ "." "_build" $(BUILDDOCOPTS)
clean:
rm -rf _build/${DOCTYPE}
help:
@echo
@echo Makefile for the call of $(BUILDDOC).
@echo Provides the interface by environment variables:
@echo - BUILDDOC: name of build tool, default 'sphinx-build'
@echo - DOCTYPE: type of created document, default 'html'
@echo
@echo The call additionally supports the pass-through of additional options
@echo to the build tool.
@echo - BUILDDOCOPTS: options to be appended to the call of name 'BUILDDOC'.
@echo
@echo The following are intentionally fixed and cannot be modified by parameters:
@echo
@echo - BUILDDIR: name of target directory for build output, constant '_build'
@echo - DOCSOURCE: the document source, constant '.'
@echo
@echo for help on build tool call 'make help-sphinx'
@echo
help-sphinx:
@$(BUILDDOC) -M help "." "_build" $(BUILDDOCOPTS)
|