You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1.1 KiB

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 .