Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

use exclude pattern for generating docs #134

Merged
merged 1 commit into from
Dec 2, 2024
Merged

use exclude pattern for generating docs #134

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,11 @@ test: ## run all tests

.PHONY: all build test clean

SUBDIRS = pkg/configReader pkg/dbcrypt pkg/errorResponses pkg/jobQueue pkg/notifications pkg/openSearch/esextension\
pkg/openSearch/openSearchClient pkg/openSearch/openSearchQuery pkg/query/ pkg/query/filter pkg/query/paging\
pkg/query/sorting pkg/retryableRequest pkg/secretfiles pkg/slices pkg/testFolder pkg/postgres/query
.PHONY: generate_docs $(SUBDIRS)
generate_docs: check_tools $(SUBDIRS)
$(SUBDIRS):
@cd $@; gomarkdoc -e --output README.md .
@echo "Generated documentation in $@"
.PHONY: generate_docs
generate_docs: check_tools
gomarkdoc -e --output '{{.Dir}}/README.md' \
--exclude-dirs .,./pkg/configReader/helper,./pkg/dbcrypt/config,./pkg/openSearch/openSearchClient/config \
./...

check_tools:
@command -v gomarkdoc >/dev/null || $(INSTALL_GOMARKDOC)
Loading