From b8c27ef1e6e5eba49b7ee8258701917b41830cef Mon Sep 17 00:00:00 2001 From: Vikash Kothary Date: Thu, 30 Jul 2020 20:21:33 +0100 Subject: [PATCH] Add docs command to build and serve documentation --- Makefile | 4 ++++ config/.env.example | 10 ++++++++++ 2 files changed, 14 insertions(+) diff --git a/Makefile b/Makefile index 0404dba..5f20ee0 100644 --- a/Makefile +++ b/Makefile @@ -13,6 +13,10 @@ export help: @awk 'BEGIN {FS = " ?#?: "; print ""${ANKI_SERVER_NAME}" "${ANKI_SERVER_VERSION}"\n"${ANKI_SERVER_DESCRIPTION}"\n\nUsage: make \033[36m\033[0m\n\nCommands:"} /^.PHONY: ?[a-zA-Z_-]/ { printf " \033[36m%-10s\033[0m %s\n", $$2, $$3 }' $(MAKEFILE_LIST) +.PHONY: docs #: Build and serve documentation. +docs: print-env + @${MKDOCS} ${MKDOCS_OPTION} -f docs/mkdocs.yml + %: @test -f scripts/${*}.sh @${SHELL} scripts/${*}.sh \ No newline at end of file diff --git a/config/.env.example b/config/.env.example index e69de29..13e35b2 100644 --- a/config/.env.example +++ b/config/.env.example @@ -0,0 +1,10 @@ +# .env.example (anki-sync-server) + +## Make +MKDOCS=mkdocs + +## Mkdocs +MKDOCS_OPTION=serve + +## Path +PATH:=.venv/bin/path:${PATH} \ No newline at end of file