Merge pull request #21 from joshraphael/docs-generation

add local embedded doc generation

Author: joshraphael

.gitignore

@@ -1,2 +1,3 @@
 cover.*
-vendor/
+vendor/
+_site/

Makefile

@@ -8,5 +8,9 @@ test:
 smoke:
 	bash ./scripts/smoke.sh
 
-docs:
-	godoc -http=:8080
+docs: docs-gen
+	cd _site && python3 -m http.server 8080
+
+docs-gen:
+	rm -rf _site/
+	doc2go -embed -out _site ./...

README.md

@@ -136,4 +136,12 @@ For convenience, the API docs and examples can be found in the tables below
 |`GetMostRecentTickets()`|Gets ticket metadata information about the latest opened achievement tickets on RetroAchievements.|[docs](https://api-docs.retroachievements.org/v1/get-ticket-data/get-most-recent-tickets.html) \| [example](examples/ticket/getmostrecenttickets/getmostrecenttickets.go)|
 |`GetGameTicketStats()`|Gets ticket stats for a game, targeted by that game's unique ID.|[docs](https://api-docs.retroachievements.org/v1/get-ticket-data/get-game-ticket-stats.html) \| [example](examples/ticket/getgameticketstats/getgameticketstats.go)|
 |`GetDeveloperTicketStats()`|Gets ticket stats for a developer, targeted by that developer's site username.|[docs](https://api-docs.retroachievements.org/v1/get-ticket-data/get-developer-ticket-stats.html) \| [example](examples/ticket/getdeveloperticketstats/getdeveloperticketstats.go)|
-|`GetAchievementTicketStats()`|Gets ticket stats for an achievement, targeted by that achievement's unique ID.|[docs](https://api-docs.retroachievements.org/v1/get-ticket-data/get-achievement-ticket-stats.html) \| [example](examples/ticket/getachievementticketstats/getachievementticketstats.go)|
+|`GetAchievementTicketStats()`|Gets ticket stats for an achievement, targeted by that achievement's unique ID.|[docs](https://api-docs.retroachievements.org/v1/get-ticket-data/get-achievement-ticket-stats.html) \| [example](examples/ticket/getachievementticketstats/getachievementticketstats.go)|
+
+## Documentation
+This library uses [doc2go](https://abhinav.github.io/doc2go/) to generate local static docs for the package. you will first need to install the package and then run the make command to serve up the site
+
+```sh
+go install go.abhg.dev/doc2go@latest
+make docs
+```