From f8228af2d8683d0518a7dfcee7e754e697e6355c Mon Sep 17 00:00:00 2001 From: Sandrine Bailleux Date: Tue, 21 Apr 2020 14:45:00 +0200 Subject: Add support for documentation build as a target in Makefile Command to build HTML-formatted pages from docs: > make doc Change-Id: I63938aaf3913126ab9036a6acaaf786a1199aef2 Signed-off-by: Sandrine Bailleux --- Makefile | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'Makefile') diff --git a/Makefile b/Makefile index f5f1c3f..1851775 100644 --- a/Makefile +++ b/Makefile @@ -78,6 +78,8 @@ PLATFORMS := $(shell find plat/ -name '${PLAT_MAKEFILE}' -print0 | \ sed -r 's%[^\x00]*\/([^/]*)\/${PLAT_MAKEFILE}\x00%\1|%g' | \ sed -r 's/\|$$//') +DOCS_PATH := docs + # Convenience function for adding build definitions # $(eval $(call add_define,BAR_DEFINES,FOO)) will have: # -DFOO if $(FOO) is empty; -DFOO=$(FOO) otherwise @@ -490,6 +492,10 @@ el3_payload: $(BUILD_DIR) all: el3_payload endif +doc: + @echo " BUILD DOCUMENTATION" + ${Q}${MAKE} --no-print-directory -C ${DOCS_PATH} html + .PHONY: cscope cscope: @echo " CSCOPE" @@ -517,6 +523,7 @@ help: @echo " checkcodebase Check the coding style of the entire source tree" @echo " checkpatch Check the coding style on changes in the current" @echo " branch against BASE_COMMIT (default origin/master)" + @echo " doc Build html based documentation using Sphinx tool" @echo " clean Clean the build for the selected platform" @echo " cscope Generate cscope index" @echo " distclean Remove all build artifacts for all platforms" -- cgit v1.2.3