tools

History

Yury Smolsky 27eedfbdea [release-branch.go1.10] cmd/godoc: fix TestWebIndex test The godoc in the test was indexing sources in the default GOPATH. If the default GOPATH pointed to local workspace, test would timeout. The fix is to supply GOPATH set to non-existing path. Fixes golang/go#24504 Change-Id: Iedf044cdec78d5c5642105650ad8ec17aa10a5ba Reviewed-on: https://go-review.googlesource.com/102295 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org> Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> (cherry picked from commit `77106db15f`) Reviewed-on: https://go-review.googlesource.com/102796 Run-TryBot: Andrew Bonventre <andybons@golang.org> Reviewed-by: Andrew Bonventre <andybons@golang.org>		2018-03-28 02:06:15 +00:00
..
README.godoc-app	go.tools: use golang.org/x/... import paths	2014-11-10 08:50:40 +11:00
appinit.go	cmd/godoc: serve proxy paths without host enforcer	2015-09-23 05:23:18 +00:00
autocert.go	cmd/godoc: optional ACME autocert support	2016-11-30 23:52:24 +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: Fix package comment inconsistencies.	2017-03-04 00:53:44 +00:00
godoc19_test.go	cmd/godoc: fix expected test output for Go 1.8 and older	2017-04-26 05:21:38 +00:00
godoc_test.go	[release-branch.go1.10] cmd/godoc: fix TestWebIndex test	2018-03-28 02:06:15 +00:00
handlers.go	cmd/godoc: allow golang.google.cn as a valid host	2018-01-20 03:13:38 +00:00
index.go	cmd/godoc: exclude /pkg from search indexing	2015-03-12 00:26:38 +00:00
main.go	[release-branch.go1.10] godoc: init corpus in a separate goroutine in http mode	2018-03-27 23:32:53 +00:00
play.go	cmd/godoc: always serve fmt handler, HTTPS fix redirection	2015-09-25 02:10:07 +00: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	godoc: proxy /compile requests to play.golang.org	2018-01-04 23:58:58 +00:00
x.go	cmd/godoc: add perf subrepo	2016-12-20 20:09:41 +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 .