qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-20 11:34:48 -07:00
Code Releases Activity
9815515df1
go/src/cmd/godoc
History
Shenghou Ma e412761488 cmd/godoc: update App Engine README and script for Go 1 
R=adg, dsymonds
CC=golang-dev
https://golang.org/cl/5849053
2012-04-26 14:24:53 +08:00
..
appinit.go godoc: update appinit.go, apply !appengine build constrain to main.go 2012-04-04 00:00:26 +08:00
codewalk.go godoc: replace servePage's positional argument list 2012-03-30 10:42:56 -07:00
dirtrees.go godoc: quiet log spam 2012-03-05 13:29:13 -05:00
doc.go doc: add "Godoc: documenting Go code" article 2012-03-15 14:51:44 +11:00
filesystem.go godoc: fix vet warnings for untagged struct literals 2012-03-14 13:19:39 +11:00
format.go go/scanner: remove (exported) InsertSemis mode 2012-01-11 10:06:44 -08:00
godoc.go godoc: replace servePage's positional argument list 2012-03-30 10:42:56 -07:00
index.go godoc: support $GOPATH, simplify file system code 2012-03-05 10:02:46 -05:00
main.go godoc: update appinit.go, apply !appengine build constrain to main.go 2012-04-04 00:00:26 +08:00
parser.go godoc: support $GOPATH, simplify file system code 2012-03-05 10:02:46 -05:00
README.godoc-app cmd/godoc: update App Engine README and script for Go 1 2012-04-26 14:24:53 +08:00
setup-godoc-app.bash cmd/godoc: update App Engine README and script for Go 1 2012-04-26 14:24:53 +08:00
snippet.go cmd, pkg/go/*: fix "go vet" warnings for go/ast and go/printer 2012-02-16 22:43:41 +11:00
spec.go renaming_4: gofix -r everything/but/src/pkg 2011-11-08 15:43:02 -08:00
template.go godoc: use FormatText for formating code in html template. 2012-03-16 15:33:05 -07:00
throttle.go use new time API 2011-11-30 12:01:46 -05:00
utils.go godoc: support $GOPATH, simplify file system code 2012-03-05 10:02:46 -05:00
zip.go godoc: support $GOPATH, simplify file system code 2012-03-05 10:02:46 -05:00

README.godoc-app 

Copyright 2011 The Go Authors. All rights reserved.
Use of this source code is governed by a BSD-style
license that can be found in the LICENSE file.

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


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
	godoc.zip
	godoc/
	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

* The godoc/ directory contains a copy of the files under $GOROOT/src/cmd/godoc
  with doc.go excluded (it belongs to pseudo-package "documentation")


Configuring and running godoc
-----------------------------

To configure godoc, run

	bash setup-godoc-app.bash

to create the godoc.zip, index.split.*, and godoc/appconfig.go files
based on $GOROOT and $APPDIR. See the script for details on usage.

To run godoc locally, using the app-engine emulator, run

	<path to google_appengine>/dev_appserver.py $APPDIR

godoc should come up at http://localhost:8080 .