mirror of
https://github.com/golang/go
synced 2024-11-06 01:56:12 -07:00
bd69d2dd34
Godoc documentation did not mention the feature for showing example code runnable by the testing package. Add a link to the testing package. Update golang/go#9471 Change-Id: Ic15794c59732e9b0b42c5b16c60be0a47c41afa5 Reviewed-on: https://go-review.googlesource.com/2490 Reviewed-by: Andrew Gerrand <adg@golang.org> |
||
|---|---|---|
| .. | ||
| appinit.go | ||
| blog.go | ||
| codewalk.go | ||
| dl.go | ||
| doc.go | ||
| godoc_test.go | ||
| handlers.go | ||
| main.go | ||
| play.go | ||
| README.godoc-app | ||
| remotesearch.go | ||
| setup-godoc-app.bash | ||
| x.go | ||
godoc on appengine ------------------ Prerequisites ------------- * Go appengine SDK https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_for_Go * Go sources at tip under $GOROOT * Godoc sources at tip inside $GOPATH (go get -d golang.org/x/tools/cmd/godoc) Directory structure ------------------- * Let $APPDIR be the directory containing the app engine files. (e.g., $APPDIR=$HOME/godoc-app) * $APPDIR contains the following entries (this may change depending on app-engine release and version of godoc): app.yaml golang.org/x/tools/cmd/godoc godoc.zip index.split.* * The app.yaml file is set up per app engine documentation. For instance: application: godoc-app version: 1 runtime: go api_version: go1 handlers: - url: /.* script: _go_app Configuring and running godoc ----------------------------- To configure godoc, run bash setup-godoc-app.bash to prepare an $APPDIR as described above. See the script for details on usage. To run godoc locally, using the App Engine development server, run <path to go_appengine>/dev_appserver.py $APPDIR godoc should come up at http://localhost:8080 .