98f73cf1ed
Developer documentation is written in Markdown and can be built into HTML, PDF, etc. using Sphinx. Diagrams are written in PlantUML and rendered as SVGs. All developer docs live in the `developer-docs` folder under the root of the repository.
29 lines
675 B
Makefile
29 lines
675 B
Makefile
SPHINXOPTS ?=
|
|
SPHINXBUILD ?= sphinx-build
|
|
SOURCEDIR = .
|
|
BUILDDIR = _build
|
|
|
|
html: Makefile graphics
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
pdf: Makefile graphics
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
.PHONY: graphics Makefile
|
|
|
|
SVG_FILES = \
|
|
providers/resource-lifecycle.svg \
|
|
architecture/construct.svg \
|
|
architecture/create.svg \
|
|
architecture/delete-before-replace-graph.svg \
|
|
architecture/delete-before-replace.svg \
|
|
architecture/import.svg \
|
|
architecture/replace.svg \
|
|
architecture/same.svg \
|
|
architecture/update.svg
|
|
|
|
%.svg: %.uml
|
|
plantuml -tsvg $<
|
|
|
|
graphics: Makefile $(SVG_FILES)
|