From 8201d7e4655e53a178032162d7e082f54a9006fb Mon Sep 17 00:00:00 2001 From: Daniel Oliveira Date: Fri, 15 Sep 2023 11:26:58 +0100 Subject: [PATCH] feat(doc8): add doc8 checker to ci.mk Signed-off-by: Daniel Oliveira --- ci.mk | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/ci.mk b/ci.mk index 95b42a7..1884927 100644 --- a/ci.mk +++ b/ci.mk @@ -340,5 +340,22 @@ endef ############################################################################# -ci=$(eval $(call $1, $2, $3, $4, $5, $6, $7, $8, $9)) +# reST Formatting +# Provides one make target: +# make rst-format # checks if the provided reST files are formated correctly +# @param root folder that contains the reST files +# @example $(call ci, docformat, /path/to/doc/folder) + +rst-format: + @doc8 $(_path_rst_files) --ignore D000 +.PHONY: rst-format +non_build_targets+=doc-format + +define rstformat +_path_rst_files+=$1 +endef + +############################################################################# + +ci=$(eval $(call $1, $2, $3, $4, $5, $6, $7, $8, $9))