qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-10-01 12:48:33 -06:00
Code Releases Activity
df6f0829a2
go/cmd/godoc
History
Brad Fitzpatrick 626e9341d5 godoc: add forgotten file from last CL to fix build 
R=adg, franciscossouza, dave
CC=golang-dev
https://golang.org/cl/25650043
2013-11-12 15:46:25 -08:00
..
appinit.go go.tools/cmd/godoc: fix app engine version; update build script and readme 2013-10-03 14:29:16 +10:00
blog.go go.tools/cmd/blog: handle "/blog/" redirect properly 2013-10-03 18:10:57 +10:00
codewalk.go go.tools/godoc: move redirect helpers to new package 2013-10-01 16:32:13 +10:00
doc.go go.tools/cmd/godoc: point at doc.ToHTML documentation for formatting rules 2013-10-02 22:08:24 -04:00
godoc_test.go cmd/godoc: Fix reg test on Windows. 2013-07-19 10:31:12 +10:00
handlers.go go.tools/godoc: provide an explicit mux to register redirects 2013-10-02 13:13:34 +10:00
main.go godoc: add forgotten file from last CL to fix build 2013-11-12 15:46:25 -08:00
play.go go.tools/cmd/godoc: update import paths 2013-09-19 10:59:21 +10:00
README.godoc-app go.tools/cmd/godoc: fix app engine version; update build script and readme 2013-10-03 14:29:16 +10: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 go.tools/cmd/godoc: fix app engine version; update build script and readme 2013-10-03 14:29:16 +10: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 code.google.com/p/go.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
	code.google.com/p/go.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 .