go/godoc at 99c318c742339e824d89d23ba3b3bff4f4ab27a8 - go

qbit/go

mirror of https://github.com/golang/go synced 2024-11-05 11:36:10 -07:00

History

Andrew Gerrand 9cd799205e cmd/godoc: add redirect for x/term repo Update golang/go#13104 Change-Id: I76102038d8dc87503c9a8994f9008b1a9fdb19d4 Reviewed-on: https://go-review.googlesource.com/17020 Reviewed-by: Dave Cheney <dave@cheney.net>		2015-11-18 05:08:28 +00:00
..
appinit.go	cmd/godoc: serve proxy paths without host enforcer	2015-09-23 05:23:18 +00:00
blog.go	go.tools: use golang.org/x/... import paths	2014-11-10 08:50:40 +11:00
codewalk.go	go.tools: use golang.org/x/... import paths	2014-11-10 08:50:40 +11:00
dl.go	godoc/{dl,proxy,short}: move packages out of Google's internal repo	2015-09-23 03:53:05 +00:00
doc.go	cmd/godoc: mention examples feature in godoc	2015-01-08 02:02:02 +00:00
godoc_test.go	godoc: fix source links for cmd/*	2015-09-11 00:20:26 +00:00
handlers.go	cmd/godoc: set Content-Type in fmt handler	2015-09-28 02:55:19 +00:00
index.go	cmd/godoc: exclude /pkg from search indexing	2015-03-12 00:26:38 +00:00
main.go	cmd/godoc: exclude /pkg from search indexing	2015-03-12 00:26:38 +00:00
play.go	cmd/godoc: always serve fmt handler, HTTPS fix redirection	2015-09-25 02:10:07 +00:00
README.godoc-app	go.tools: use golang.org/x/... import paths	2014-11-10 08:50:40 +11:00
remotesearch.go	go.tools/cmd/godoc: update appinit.go to use new godoc packages	2013-07-30 14:23:23 +10:00
setup-godoc-app.bash	cmd/godoc: make setup-godoc-app.bash more portable	2015-09-27 06:24:22 +00:00
x.go	cmd/godoc: add redirect for x/term repo	2015-11-18 05:08:28 +00:00

README.godoc-app

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 .