github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-20 12:42:54 +00:00
Code Issues Projects Releases Wiki Activity

Build system: add target to build documentation

Browse Source 
This patch adds a new target to build the documentation
from the top-level directory. Here is how to use it (from
the top-level source directory):
   $ make doc
Or
   $ make O=build-test doc

To clean all documentation build artefacts, simply call
   $ make clean
Or
   $ make O=build-test clean

Calling 'make' with no arguments will *not* build the
documentation by default.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
This commit is contained in:
Geoffroy Van Cutsem 2018-06-12 11:38:43 +02:00 committed by Jack Ren
parent 0dd3f8dbe6
commit 2425583c6b
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Makefile
View File

@ -10,9 +10,10 @@ HV_OUT := $(ROOT_OUT)/hypervisor
DM_OUT := $(ROOT_OUT)/devicemodel DM_OUT := $(ROOT_OUT)/devicemodel
TOOLS_OUT := $(ROOT_OUT)/tools TOOLS_OUT := $(ROOT_OUT)/tools
MISC_OUT := $(ROOT_OUT)/misc MISC_OUT := $(ROOT_OUT)/misc
DOC_OUT := $(ROOT_OUT)/doc
export TOOLS_OUT export TOOLS_OUT
.PHONY: all hypervisor devicemodel tools misc .PHONY: all hypervisor devicemodel tools misc doc
all: hypervisor devicemodel tools misc all: hypervisor devicemodel tools misc
hypervisor: hypervisor:
@ -36,9 +37,13 @@ misc: tools
mkdir -p $(MISC_OUT) mkdir -p $(MISC_OUT)
make -C $(T)/misc OUT_DIR=$(MISC_OUT) make -C $(T)/misc OUT_DIR=$(MISC_OUT)
doc:
make -C $(T)/doc html BUILDDIR=$(DOC_OUT)
.PHONY: clean .PHONY: clean
clean: clean:
make -C $(T)/tools OUT_DIR=$(TOOLS_OUT) clean make -C $(T)/tools OUT_DIR=$(TOOLS_OUT) clean
make -C $(T)/doc BUILDDIR=$(DOC_OUT) clean
rm -rf $(ROOT_OUT) rm -rf $(ROOT_OUT)
.PHONY: install .PHONY: install

2
doc/Makefile
View File

@ -12,7 +12,7 @@ SPHINXOPTS ?= -q
SPHINXBUILD = sphinx-build SPHINXBUILD = sphinx-build
SPHINXPROJ = "Project ACRN" SPHINXPROJ = "Project ACRN"
SOURCEDIR = . SOURCEDIR = .
BUILDDIR = _build BUILDDIR ?= _build
DOC_TAG ?= development DOC_TAG ?= development
RELEASE ?= latest RELEASE ?= latest