Created
November 24, 2021 23:23
-
-
Save mrwormhole/9eebb821e0aa79f8599920fc0aa34b24 to your computer and use it in GitHub Desktop.
Godoc static HTML generator
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| #!/usr/bin/env bash | |
| function extract_module_name { | |
| # Extract module name | |
| sed -n -E 's/^\s*module\s+([[:graph:]]+)\s*$/\1/p' | |
| } | |
| function normalize_url { | |
| # Normalize provided URL. Removing double slashes | |
| echo "$1" | sed -E 's,([^:]/)/+,\1,g' | |
| } | |
| function generate_go_documentation { | |
| # Go doc | |
| local URL | |
| local PID | |
| local STATUS | |
| # Setup | |
| rm -rf "${GO_DOC_HTML_OUTPUT:-godoc}" | |
| # Extract Go module name from a Go module file | |
| if [[ -z "$GO_MODULE" ]]; then | |
| local FILE | |
| FILE="$(go env GOMOD)" | |
| if [[ -f "$FILE" ]]; then | |
| GO_MODULE=$(cat "$FILE" | extract_module_name) | |
| fi | |
| fi | |
| # URL path to Go package and module documentation | |
| URL=$(normalize_url "http://${GO_DOC_HTTP:-localhost:6060}/pkg/$GO_MODULE/") | |
| # Starting godoc server | |
| echo "Starting godoc server..." | |
| godoc -http="${GO_DOC_HTTP:-localhost:6060}" & | |
| PID=$! | |
| # Waiting for godoc server | |
| while ! curl --fail --silent "$URL" 2>&1 >/dev/null; do | |
| sleep 0.1 | |
| done | |
| # Download all documentation content from running godoc server | |
| wget \ | |
| --recursive \ | |
| --no-verbose \ | |
| --convert-links \ | |
| --page-requisites \ | |
| --adjust-extension \ | |
| --execute=robots=off \ | |
| --include-directories="/lib,/pkg/$GO_MODULE,/src/$GO_MODULE" \ | |
| --exclude-directories="*" \ | |
| --directory-prefix="${GO_DOC_HTML_OUTPUT:-godoc}" \ | |
| --no-host-directories \ | |
| "$URL" | |
| # Stop godoc server | |
| kill -9 "$PID" | |
| echo "Stopped godoc server" | |
| echo "Go source code documentation generated under ${GO_DOC_HTML_OUTPUT:-godoc}" | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment