tools

History

Dmitri Shuralyov a663d825ff cmd/godoc: Fix package comment inconsistencies. Remove inadvertent and unwanted spaces in the middle of an indented block. Insert blank lines before indented sections for consistency. Insert colon after "pointer" for consistency with "type". Fixes golang/go#19356. Change-Id: Iaae12f69d17adb51a27b516727c13132cb8df8e8 Reviewed-on: https://go-review.googlesource.com/37660 Reviewed-by: Daniel Martí <mvdan@mvdan.cc> Reviewed-by: Dominik Honnef <dominik@honnef.co> Run-TryBot: Dominik Honnef <dominik@honnef.co>		2017-03-04 00:53:44 +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
godoc_test.go	godoc: preserve ?m=... query string	2017-02-08 21:12:11 +00:00
handlers.go	cmd/godoc: set Strict-Transport-Security header in production	2016-05-02 17:22:30 +00:00
index.go	cmd/godoc: exclude /pkg from search indexing	2015-03-12 00:26:38 +00:00
main.go	x/tools/cmd/godoc: remove unused variable	2017-03-01 14:52:40 +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	cmd/godoc: make setup-godoc-app.bash more portable	2015-09-27 06:24:22 +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 .