1da8801a95
At least inside this one package. It's because golang.org/x/tools/cmd/godoc no longer has CLI support as of golang/go#25443, it is now only a web server. Luckily, browsers that display HTML pages are not constrained to the fixed width of punched cards. On the contrary, they seem to embrace a wide variety of arbitrary page widths, ranging from narrow to wide. This is in part due to the proliferation of internet access on device form factors such as the mobile phone, tablet, laptop, and desktop. So the punchCardWidth constant is now unused and can be removed. This is a followup to CL 141397 that removed most of the CLI support code, including the function comment_textFunc, which was its only user. Same goes for containsOnlySpace. Updates golang/go#25443 Change-Id: I61fabe6ea801c88758fb2c6aefa70b53d52e2cb5 Reviewed-on: https://go-review.googlesource.com/c/tools/+/172975 Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org> |
||
|---|---|---|
| .. | ||
| analysis | ||
| golangorgenv | ||
| redirect | ||
| static | ||
| util | ||
| vfs | ||
| corpus.go | ||
| dirtrees_test.go | ||
| dirtrees.go | ||
| format.go | ||
| godoc17_test.go | ||
| godoc_test.go | ||
| godoc.go | ||
| index_test.go | ||
| index.go | ||
| linkify.go | ||
| meta.go | ||
| page.go | ||
| parser.go | ||
| pres.go | ||
| README.md | ||
| search.go | ||
| server_test.go | ||
| server.go | ||
| snippet.go | ||
| spec_test.go | ||
| spec.go | ||
| spot.go | ||
| tab.go | ||
| template.go | ||
| versions_test.go | ||
| versions.go | ||
godoc
This directory contains most of the code for running a godoc server. The executable lives at golang.org/x/tools/cmd/godoc.
Development mode
In production, CSS/JS/template assets need to be compiled into the godoc binary. It can be tedious to recompile assets every time, but you can pass a flag to load CSS/JS/templates from disk every time a page loads:
godoc -templates=$GOPATH/src/golang.org/x/tools/godoc/static -http=:6060
Recompiling static assets
The files that live at static/style.css, static/jquery.js and so on are not
present in the final binary. They are placed into static/static.go by running
go generate. So to compile a change and test it in your browser:
-
Make changes to e.g.
static/style.css. -
Run
go generate golang.org/x/tools/godoc/staticsostatic/static.gopicks up the change. -
Run
go install golang.org/x/tools/cmd/godocso the compiledgodocbinary picks up the change. -
Run
godoc -http=:6060and view your changes in the browser. You may need to disable your browser's cache to avoid reloading a stale file.