You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

56 lines
1.1 KiB

  1. godoc on appengine
  2. ------------------
  3. Prerequisites
  4. -------------
  5. * Go appengine SDK
  6. https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_for_Go
  7. * Go sources at tip under $GOROOT
  8. * Godoc sources at tip inside $GOPATH
  9. (go get -d golang.org/x/tools/cmd/godoc)
  10. Directory structure
  11. -------------------
  12. * Let $APPDIR be the directory containing the app engine files.
  13. (e.g., $APPDIR=$HOME/godoc-app)
  14. * $APPDIR contains the following entries (this may change depending on
  15. app-engine release and version of godoc):
  16. app.yaml
  17. golang.org/x/tools/cmd/godoc
  18. godoc.zip
  19. index.split.*
  20. * The app.yaml file is set up per app engine documentation.
  21. For instance:
  22. application: godoc-app
  23. version: 1
  24. runtime: go
  25. api_version: go1
  26. handlers:
  27. - url: /.*
  28. script: _go_app
  29. Configuring and running godoc
  30. -----------------------------
  31. To configure godoc, run
  32. bash setup-godoc-app.bash
  33. to prepare an $APPDIR as described above. See the script for details on usage.
  34. To run godoc locally, using the App Engine development server, run
  35. <path to go_appengine>/dev_appserver.py $APPDIR
  36. godoc should come up at http://localhost:8080 .