feat(docs): auto generate api docs using Makefile target

- Changes automate the api docs generate process via adding templates and configs. - docs will be generate as the `docs/api-references/apis.md` - Add Makefile target `gen-api-docs` Signed-off-by: prateekpandey14 <[email protected]>
openebs-archive · Jun 9, 2020 · 61da55f · 61da55f
1 parent 0177387
commit 61da55f
Show file tree

Hide file tree

Showing 43 changed files with 12,647 additions and 4 deletions.
diff --git a/Makefile b/Makefile
@@ -207,3 +207,8 @@ deploy-images:
 	@DIMAGE=${IMAGE_ORG}/cstor-volume-manager-${XC_ARCH} ./build/push;
 	@DIMAGE=${IMAGE_ORG}/cstor-pool-manager-${XC_ARCH} ./build/push;
 	@DIMAGE=${IMAGE_ORG}/cstor-webhook-${XC_ARCH} ./build/push;
+
+.PHONY: gen-api-docs
+gen-api-docs:
+	@echo ">> generating cstor 'v1' apis docs"
+	go run github.com/ahmetb/gen-crd-api-reference-docs -api-dir ../api/pkg/apis/cstor/v1 -config hack/api-docs/config.json -template-dir hack/api-docs/template -out-file docs/api-references/apis.md