Skip to content

Commit

Permalink
feat(doc8): add doc8 checker to ci.mk
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Oliveira <[email protected]>
  • Loading branch information
danielRep committed Sep 15, 2023
1 parent 3003881 commit 8201d7e
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion ci.mk
Original file line number Diff line number Diff line change
Expand Up @@ -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))

0 comments on commit 8201d7e

Please sign in to comment.