qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-18 12:14:42 -07:00
Code Releases Activity
af97332187
go/cmd/godoc
History
Andrew Gerrand af97332187 cmd/godoc: send go-source meta tag for golang.org/x repos 
This allows godoc.org to link to the source code. I chose to link to
github.com instead of googlesource.com because their file browser is
better.

Details here:
864b1c0aba

Change-Id: I962b3fadc822e753245f52240937be5c7e158dc7
Reviewed-on: https://go-review.googlesource.com/2719
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2015-01-14 02:42:10 +00:00
..
appinit.go cmd/godoc: show the BUG section 2014-12-28 23:27:51 +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 go.tools/cmd/godoc: register redirect handler for /dl/ 2014-06-18 15:44:09 +10:00
doc.go cmd/godoc: mention examples feature in godoc 2015-01-08 02:02:02 +00:00
godoc_test.go go.tools/cmd/godoc: wait for godoc to exit before removing tmp directory 2014-10-28 16:59:58 +11:00
handlers.go go.tools: use golang.org/x/... import paths 2014-11-10 08:50:40 +11:00
main.go cmd/godoc: add missing space to flag description 2014-12-19 19:42:26 +00:00
play.go go.tools: use golang.org/x/... import paths 2014-11-10 08:50:40 +11: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: update GAE setup script 2014-12-19 02:48:01 +00:00
x.go cmd/godoc: send go-source meta tag for golang.org/x repos 2015-01-14 02:42:10 +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 .