github.com/newrelic/newrelic-client-go@v1.1.0/build/document.mk (about)

     1  #
     2  # Makefile fragment for displaying auto-generated documentation
     3  #
     4  
     5  GODOC       ?= godoc
     6  GODOC_HTTP  ?= "localhost:6060"
     7  
     8  CHANGELOG_CMD      ?= git-chglog
     9  CHANGELOG_FILE     ?= CHANGELOG.md
    10  
    11  docs: tools
    12  	@echo "=== $(PROJECT_NAME) === [ docs             ]: Starting godoc server..."
    13  	@echo "=== $(PROJECT_NAME) === [ docs             ]:"
    14  	@echo "=== $(PROJECT_NAME) === [ docs             ]: NOTE: This only works if this codebase is in your GOPATH!"
    15  	@echo "=== $(PROJECT_NAME) === [ docs             ]:    godoc issue: https://github.com/golang/go/issues/26827"
    16  	@echo "=== $(PROJECT_NAME) === [ docs             ]:"
    17  	@echo "=== $(PROJECT_NAME) === [ docs             ]: Module Docs: http://$(GODOC_HTTP)/pkg/$(PROJECT_MODULE)"
    18  	@$(GODOC) -http=$(GODOC_HTTP)
    19  
    20  changelog: tools
    21  	@echo "=== $(PROJECT_NAME) === [ changelog        ]: Generating changelog..."
    22  	@$(CHANGELOG_CMD) --silent -o $(CHANGELOG_FILE)
    23  
    24  .PHONY: docs changelog