Makefile

PROJ_DIR := ${CURDIR}

default: generate-docs

generate-docs:
	@jazzy --config 'Documentation/Jazzy Configurations/Jetworking.yaml' --output docs; \
	sed -i '' -e "s|$(PROJ_DIR)|Root|g" docs/undocumented.json; \
	jazzy --config 'Documentation/Jazzy Configurations/DataTransfer.yaml' --output docs/Modules/DataTransfer; \
	sed -i '' -e "s|$(PROJ_DIR)|Root|g" docs/Modules/DataTransfer/undocumented.json; \
	echo "✅ Documentation generated and stored in the docs folder";

lint-docsUpToDate:
	@echo "📄 Generating documentation to check whether it matches the content of the docs folder..."; \
	jazzy --config 'Documentation/Jazzy Configurations/Jetworking.yaml' --output .docsGeneratedByLint; \
	sed -i '' -e "s|$(PROJ_DIR)|Root|g" .docsGeneratedByLint/undocumented.json; \
	jazzy --config 'Documentation/Jazzy Configurations/DataTransfer.yaml' --output .docsGeneratedByLint/Modules/DataTransfer; \
	sed -i '' -e "s|$(PROJ_DIR)|Root|g" .docsGeneratedByLint/Modules/DataTransfer/undocumented.json; \
	if ! find docs .docsGeneratedByLint -type f ! -name 'undocumented.json' -print | sed -e 's|.*/||' | diff -X - -r docs .docsGeneratedByLint &>/dev/null; then \
		>&2 echo "⛔️ The content of the docs folder is not up-to-date. This issue can be addressed by regenerating the docs."; \
		exit 1; \
	fi; \
	echo "✅ Linting successful: Documentation in the docs folder is up-to-date."; \
	rm -rf .docsGeneratedByLint;

.PHONY: generate-docs