Generate api docs from source code

.circleci/config.yml

@@ -7,6 +7,9 @@ jobs:
       - run:
           name: unit tests
           command: make test
+      - run:
+          name: api-docs
+          command: make gen-api-docs
       - run:
           name: docs
           command: docker run --rm -u $UID -it -p 8000:8000 -v $PWD:/docs squidfunk/mkdocs-material build

.gitignore

@@ -1,4 +1,5 @@
 site
+docs/api-docs.md
 *_test_output.json
 e2e/node_modules
 .DS_Store

Makefile

@@ -1,19 +1,28 @@
-help:        # Show this message.
+help:         # Show this message.
 	@echo "\nAvailable Targets:\n"
 	@sed -ne '/@sed/!s/# //p' $(MAKEFILE_LIST)
 
-test:        # Run all unit tests.
-	@docker run \
+test:         # Run all unit tests.
+	@docker run --rm \
 		-w $$PWD \
 		-v $$PWD:$$PWD \
 		--entrypoint sh \
 		sparkprime/jsonnet \
 		tests.sh
 
-test-update: # Run all unit tests while copying test_output.json to compiled.json file.
-	@docker run \
+test-update:  # Run all unit tests while copying test_output.json to compiled.json file.
+	@docker run --rm \
 		-w $$PWD \
 		-v $$PWD:$$PWD \
 		--entrypoint sh \
 		sparkprime/jsonnet \
 		tests.sh update
+
+gen-api-docs: # Generate api-docs.md from source code comments.
+	@docker run --rm \
+		-u $$UID \
+		-v $$PWD:$$PWD \
+		-w $$PWD \
+		trotttrotttrott/jsonnetdoc:4f806c6 \
+		grafonnet --markdown \
+		> docs/api-docs.md

mkdocs.yml

@@ -10,3 +10,4 @@ nav:
   - Examples: 'examples.md'
   - Style Guide: 'style-guide.md'
   - Comunity Plugins: 'community-plugins.md'
+  - API Docs: 'api-docs.md'