Mercurial > gemma
changeset 4427:b195bc79e3e8
docs: add hints for starting godoc
| author | Bernhard Reiter <bernhard@intevation.de> |
|---|---|
| date | Wed, 18 Sep 2019 16:19:59 +0200 |
| parents | a769e14f4baf |
| children | 3c306481aebb |
| files | docs/DEVELOPMENT.md |
| diffstat | 1 files changed, 19 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/DEVELOPMENT.md Wed Sep 18 16:11:43 2019 +0200 +++ b/docs/DEVELOPMENT.md Wed Sep 18 16:19:59 2019 +0200 @@ -20,6 +20,25 @@ * Run Run server with `./cmd/gemma/gemma` + +### View source code documentation interactively + +Use https://godoc.org/golang.org/x/tools/cmd/godoc +(coming with package `golang-golang-x-tools` on Ubuntu.) +to see the formatted documentation. + +Started in the top level directory like + `godoc -http=:6060` +you can access the documentation at +`http://localhost:6060/pkg/gemma.intevation.de/?m=all` + +Hints: + * A parameter like `-goroot /usr/lib/go-1.12` may avoid warnings, if + the goroot is somewhere else. + * Clicking on a function declaration header will take you to the source + code. (Or changing `?m=all` to `?m=src?`). + + ## Client See [client/README](../client/README.md) for details.