2018-03-06 14:54:44 +08:00
|
|
|
# Minimal makefile for Sphinx documentation
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
# You can set these variables from the command line.
|
|
|
|
|
SPHINXOPTS =
|
|
|
|
|
SPHINXBUILD = sphinx-build
|
|
|
|
|
SPHINXPROJ = "Project ACRN"
|
|
|
|
|
SOURCEDIR = .
|
|
|
|
|
BUILDDIR = _build
|
|
|
|
|
|
2018-03-07 07:12:49 +08:00
|
|
|
PUBLISHDIR = ../projectacrn.github.io
|
|
|
|
|
|
2018-03-06 14:54:44 +08:00
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
|
|
|
help:
|
|
|
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
|
|
|
|
|
|
.PHONY: help Makefile
|
|
|
|
|
|
2018-03-07 07:12:49 +08:00
|
|
|
pullsource:
|
|
|
|
|
$(Q)scripts/pullsource.sh
|
|
|
|
|
|
|
|
|
|
|
2018-03-07 04:26:59 +08:00
|
|
|
# Generate the doxygen xml (for Sphinx) and copy the doxygen html to the
|
|
|
|
|
# api folder for publishing along with the Sphinx-generated API docs.
|
|
|
|
|
|
2018-03-07 07:12:49 +08:00
|
|
|
doxy: pullsource
|
|
|
|
|
$(Q)(cat acrn.doxyfile) | doxygen - 2>&1
|
2018-03-07 04:26:59 +08:00
|
|
|
$(Q)mkdir -p _build/html/api/doxygen
|
|
|
|
|
$(Q)cp -r doxygen/html/* _build/html/api/doxygen
|
2018-03-06 14:54:44 +08:00
|
|
|
|
2018-03-07 07:12:49 +08:00
|
|
|
# Remove generated content (Sphinx and doxygen)
|
2018-03-06 14:54:44 +08:00
|
|
|
|
|
|
|
|
clean:
|
2018-03-07 09:07:19 +08:00
|
|
|
$(Q)rm -fr $(BUILDDIR) doxygen _source
|
2018-03-07 07:12:49 +08:00
|
|
|
|
|
|
|
|
# Copy material over to the GitHub pages staging repo
|
|
|
|
|
|
|
|
|
|
publish:
|
|
|
|
|
$(Q)mv $(PUBLISHDIR)/README.md $(PUBLISHDIR)/.README.md
|
|
|
|
|
$(Q)rm -fr $(PUBLISHDIR)/*
|
|
|
|
|
$(Q)mv $(PUBLISHDIR)/.README.md $(PUBLISHDIR)/README.md
|
|
|
|
|
$(Q)cp -r _build/html/* $(PUBLISHDIR)
|
2018-03-06 14:54:44 +08: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 doxy
|
|
|
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
