2018-03-06 14:54:44 +08:00
|
|
|
# Minimal makefile for Sphinx documentation
|
|
|
|
|
#
|
|
|
|
|
|
2018-03-09 07:59:55 +08:00
|
|
|
ifeq ($(VERBOSE),1)
|
|
|
|
|
Q =
|
|
|
|
|
else
|
|
|
|
|
Q = @
|
|
|
|
|
endif
|
|
|
|
|
|
2018-03-06 14:54:44 +08:00
|
|
|
# You can set these variables from the command line.
|
2018-04-14 05:36:25 +08:00
|
|
|
SPHINXOPTS ?= -q
|
2018-03-06 14:54:44 +08:00
|
|
|
SPHINXBUILD = sphinx-build
|
|
|
|
|
SPHINXPROJ = "Project ACRN"
|
2018-06-12 17:38:43 +08:00
|
|
|
BUILDDIR ?= _build
|
2021-04-24 06:26:53 +08:00
|
|
|
SOURCEDIR = $(BUILDDIR)/rst
|
|
|
|
|
LATEXMKOPTS = -silent
|
2018-03-06 14:54:44 +08:00
|
|
|
|
2018-06-15 04:54:59 +08:00
|
|
|
# document publication assumes the folder structure is setup
|
|
|
|
|
# with the acrn-hypervisor and projectacrn.github.io repos as
|
|
|
|
|
# sibling folders and make is run inside the acrn-hypervisor/docs
|
|
|
|
|
# folder.
|
|
|
|
|
|
|
|
|
|
ACRN_BASE = "$(CURDIR)/../.."
|
2018-04-14 05:36:25 +08:00
|
|
|
DOC_TAG ?= development
|
|
|
|
|
RELEASE ?= latest
|
2018-06-15 04:54:59 +08:00
|
|
|
PUBLISHDIR = $(ACRN_BASE)/projectacrn.github.io/$(RELEASE)
|
2018-03-07 07:12:49 +08:00
|
|
|
|
2018-03-06 14:54:44 +08:00
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
|
|
|
help:
|
2018-06-12 17:34:54 +08:00
|
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(OPTS)
|
2018-05-05 00:41:59 +08:00
|
|
|
@echo ""
|
|
|
|
|
@echo "make publish"
|
|
|
|
|
@echo " publish generated html to projectacrn.github.io site:"
|
|
|
|
|
@echo " specify RELEASE=name to publish as a tagged release version"
|
2018-05-15 18:02:07 +08:00
|
|
|
@echo " and placed in a version subfolder. Requires repo merge permission."
|
2018-03-06 14:54:44 +08:00
|
|
|
|
2021-08-06 07:44:12 +08:00
|
|
|
.PHONY: help Makefile copy-to-sourcedir doxy content html singlehtml clean publish
|
2018-03-06 14:54:44 +08:00
|
|
|
|
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.
|
2021-04-24 06:26:53 +08:00
|
|
|
# This is where we tweak the "pre" API comments into "preconditions"
|
|
|
|
|
# Note that this step starts with an empty doc.log while the others append
|
|
|
|
|
doxy:
|
2019-09-10 18:18:44 +08:00
|
|
|
$(Q)(cat acrn.doxyfile ; echo "OUTPUT_DIRECTORY=$(SOURCEDIR)/doxygen" ) | doxygen - > $(BUILDDIR)/doc.log 2>&1
|
|
|
|
|
$(Q)find $(SOURCEDIR)/doxygen/xml/* | xargs sed -i 's/simplesect kind="pre"/simplesect kind="preconditions"/'
|
2018-05-30 05:07:34 +08:00
|
|
|
|
2021-04-24 06:26:53 +08:00
|
|
|
# Copy all the rst content (and images, etc) into the _build/rst folder
|
|
|
|
|
# including rst content and xsd files from the /misc folder that we'll
|
|
|
|
|
# use to generate config option documentation
|
|
|
|
|
|
|
|
|
|
content:
|
|
|
|
|
$(Q)mkdir -p $(SOURCEDIR)
|
|
|
|
|
$(Q)rsync -rt --exclude=$(BUILDDIR) . $(SOURCEDIR)
|
2019-09-10 18:18:44 +08:00
|
|
|
$(Q)scripts/extract_content.py $(SOURCEDIR) misc
|
2021-01-28 10:14:00 +08:00
|
|
|
$(Q)mkdir -p $(SOURCEDIR)/misc/config_tools/schema
|
|
|
|
|
$(Q)rsync -rt ../misc/config_tools/schema/*.xsd $(SOURCEDIR)/misc/config_tools/schema
|
|
|
|
|
$(Q)xsltproc -xinclude ./scripts/configdoc.xsl $(SOURCEDIR)/misc/config_tools/schema/config.xsd > $(SOURCEDIR)/reference/configdoc.txt
|
2019-09-10 18:18:44 +08:00
|
|
|
|
2018-07-25 07:57:40 +08:00
|
|
|
|
2021-04-24 06:26:53 +08:00
|
|
|
html: content doxy
|
|
|
|
|
@echo making HTML content
|
|
|
|
|
$(Q)./scripts/show-versions.py
|
2022-04-02 07:23:11 +08:00
|
|
|
-$(Q)$(SPHINXBUILD) -t $(DOC_TAG) -b html -d $(BUILDDIR)/doctrees $(SOURCEDIR) $(BUILDDIR)/html $(SPHINXOPTS) $(OPTS) >> $(BUILDDIR)/doc.log 2>&1
|
2019-09-10 18:18:44 +08:00
|
|
|
$(Q)./scripts/filter-doc-log.sh $(BUILDDIR)/doc.log
|
2018-03-14 07:24:35 +08:00
|
|
|
|
2021-04-24 06:26:53 +08:00
|
|
|
singlehtml: content doxy
|
2022-04-02 07:23:11 +08:00
|
|
|
-$(Q)$(SPHINXBUILD) -t $(DOC_TAG) -b singlehtml -d $(BUILDDIR)/doctrees $(SOURCEDIR) $(BUILDDIR)/html $(SPHINXOPTS) $(OPTS) >> $(BUILDDIR)/doc.log 2>&1
|
2019-09-10 18:18:44 +08:00
|
|
|
$(Q)./scripts/filter-doc-log.sh $(BUILDDIR)/doc.log
|
2018-03-14 07:24:35 +08:00
|
|
|
|
2021-04-24 06:26:53 +08:00
|
|
|
pdf: html
|
|
|
|
|
@echo now making $(BUILDDIR)/latex/acrn.pdf
|
2022-04-02 07:23:11 +08:00
|
|
|
-$(Q)make -silent latexpdf LATEXMKOPTS=$(LATEXMKOPTS) >> $(BUILDDIR)/doc.log 2>&1
|
2021-04-24 06:26:53 +08:00
|
|
|
$(Q)./scripts/filter-doc-log.sh $(BUILDDIR)/doc.log
|
|
|
|
|
|
|
|
|
|
|
2018-03-07 07:12:49 +08:00
|
|
|
# Remove generated content (Sphinx and doxygen)
|
2018-03-06 14:54:44 +08:00
|
|
|
|
|
|
|
|
clean:
|
2019-09-10 18:18:44 +08:00
|
|
|
rm -fr $(BUILDDIR)
|
2018-03-07 07:12:49 +08:00
|
|
|
|
2019-09-10 18:18:44 +08:00
|
|
|
|
2018-03-07 07:12:49 +08:00
|
|
|
# Copy material over to the GitHub pages staging repo
|
2021-04-24 06:26:53 +08:00
|
|
|
# along with a README, index.html redirect to latest/index.html, robots.txt (for
|
|
|
|
|
# search exclusions), and tweak the Sphinx-generated 404.html to work as the
|
|
|
|
|
# site-wide 404 response page. (We generate the 404.html with Sphinx so it has
|
|
|
|
|
# the current left navigation contents and overall style.)
|
2018-03-07 07:12:49 +08:00
|
|
|
|
|
|
|
|
publish:
|
2018-07-12 21:47:55 +08:00
|
|
|
mkdir -p $(PUBLISHDIR)
|
2018-09-17 05:22:09 +08:00
|
|
|
cd $(PUBLISHDIR)/..; git pull origin master
|
2018-03-09 07:59:55 +08:00
|
|
|
rm -fr $(PUBLISHDIR)/*
|
|
|
|
|
cp -r $(BUILDDIR)/html/* $(PUBLISHDIR)
|
2020-04-09 05:08:30 +08:00
|
|
|
ifeq ($(RELEASE),latest)
|
2018-04-14 05:36:25 +08:00
|
|
|
cp scripts/publish-README.md $(PUBLISHDIR)/../README.md
|
2021-10-29 02:01:55 +08:00
|
|
|
scripts/publish-redirect.sh $(PUBLISHDIR)/../index.html latest/index.html
|
|
|
|
|
scripts/publish-redirect.sh $(PUBLISHDIR)/../hardware.html latest/reference/hardware.html
|
2019-04-05 06:37:49 +08:00
|
|
|
cp scripts/publish-robots.txt $(PUBLISHDIR)/../robots.txt
|
2020-04-10 04:48:22 +08:00
|
|
|
sed 's/<head>/<head>\n <base href="https:\/\/projectacrn.github.io\/latest\/">/' $(BUILDDIR)/html/404.html > $(PUBLISHDIR)/../404.html
|
2020-04-09 05:08:30 +08:00
|
|
|
endif
|
2018-04-14 05:36:25 +08:00
|
|
|
cd $(PUBLISHDIR)/..; git add -A; git commit -s -m "publish $(RELEASE)"; git push origin master;
|
2018-03-06 14:54:44 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
2018-06-12 17:34:54 +08:00
|
|
|
# "make mode" option. $(OPTS) is meant as a shortcut for $(SPHINXOPTS).
|
2021-04-22 05:00:59 +08:00
|
|
|
%: Makefile
|
2018-06-12 17:34:54 +08:00
|
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(OPTS)
|
