Commit Graph

64 Commits

Author SHA1 Message Date
Russ Cox
2a591bdf8a godoc: add codewalk support
R=adg, gri
CC=golang-dev, r
https://golang.org/cl/1008042
2010-04-26 22:35:12 -07:00
Robert Griesemer
e8e4987ba3 godoc: support for title and subtitle headers when serving .html docs
and use it to show version (date) of go spec

Fixes #68.

R=rsc
CC=golang-dev, r
https://golang.org/cl/848042
2010-03-30 17:37:42 -07:00
Robert Griesemer
acfd6d5f05 godoc: show relative file names without leading '/' (per r's request)
- change the various url-xxx formatters to return a relative URL path
- make the leading '/' for URLs explicit in the template
- on the way change some |html formatters to |html-esc
  (html should only be used for formatting AST nodes)

R=rsc, r
CC=golang-dev
https://golang.org/cl/740041
2010-03-24 16:28:59 -07:00
Robert Griesemer
6c8fdbe8c7 godoc: line numbers for all remote search results
Instead of returning the index lookup result via
RPC which has to be corrected for the client,
simply render it on the server and return the
final output.

R=rsc, r
CC=golang-dev
https://golang.org/cl/669041
2010-03-19 22:48:08 -07:00
Russ Cox
e8fb0b014c godoc: revert change 5089, per gri's instructions
R=gri
CC=golang-dev
https://golang.org/cl/630043
2010-03-19 17:46:18 -07:00
Andrew Gerrand
7190fdd3bf website: add Go Blog widget to frontpage,
add Blog and Wiki links to sideba

R=r, rsc, gri
CC=golang-dev
https://golang.org/cl/611042
2010-03-20 11:42:57 +11:00
Robert Griesemer
b037bfa684 godoc: proper file path conversion for remote search
R=rsc
CC=golang-dev
https://golang.org/cl/664041
2010-03-19 17:07:16 -07:00
Robert Griesemer
fa462f37e3 godoc: show (some) line numbers for remote search
- show build version
- use build goroot when possible

R=rsc
CC=golang-dev
https://golang.org/cl/656043
2010-03-19 15:20:20 -07:00
Robert Griesemer
17e0351404 godoc: implemented command-line search
The command-line search is using a running webserver
as index server; i.e., the search result is reflecting
the index at the server. See the documentation for
details.

Usage: godoc -q query1 query2 ...

Known issue: Results don't show the all-important
line numbers yet due to the way the index is organized.
Next CL.

R=rsc, r
CC=golang-dev
https://golang.org/cl/648041
2010-03-19 12:46:43 -07:00
Robert Griesemer
74fac99d05 godoc: initial support for showing popup information
for identifiers in Go source code

- at the moment just show identifier kind (var, func, etc.) and name
  (eventually should show declaration, type, etc.)
- JavaScript parts by adg

R=rsc
CC=adg, golang-dev
https://golang.org/cl/578042
2010-03-16 14:17:42 -07:00
Robert Griesemer
226c2ec256 godoc: support for multiple packages in a directory
- smartly select the "right" package
- provide a list of other packages

R=rsc
CC=golang-dev
https://golang.org/cl/466042
2010-03-12 18:16:21 -08:00
Robert Griesemer
35aec6c7f7 godoc: provide mode which shows exported interface in "source form"
- on the commandline: godoc -x big
- in a webpage: provide form parameter ?m=src

Known issues:
- Positioning of comments incorrect in several cases. Separate CL.
- Need a link/menu to switch between different modes of presentation
  in the web view.

R=rsc
CC=golang-dev
https://golang.org/cl/376041
2010-03-10 15:22:22 -08:00
Andrew Gerrand
1d5af1553c First run at a Programming FAQ
Moved a couple of FAQs from the main FAQ, and added some others

R=r, rsc, iant, gri
CC=golang-dev
https://golang.org/cl/218070
2010-03-04 12:56:08 +11:00
Robert Griesemer
a5c29da313 remove absolute paths from search results
R=adg
CC=golang-dev
https://golang.org/cl/216053
2010-02-19 10:09:20 -08:00
Robert Griesemer
d17ffb9753 godoc: path cleanups, fixed a race condition, initial support for a menu on pages
R=rsc
CC=adg, golang-dev
https://golang.org/cl/215050
2010-02-18 17:40:50 -08:00
Robert Griesemer
5883c6ef1f godoc support for directories outside $GOROOT
Example use: godoc -path=/home/user1:/home/build/foo -http=:6666
will start a local godoc that maps urls starting with /pkg/user1 or
/pkg/foo to the respective roots specified in the path.

Missing: Handling of overlapping package directories, multiple
packages per directory.

R=rsc
CC=golang-dev
https://golang.org/cl/206078
2010-02-16 11:20:55 -08:00
Russ Cox
6c2e0fe1f9 create doc/talks/.
move talk-20091030 down.
add talk given at Stanford 2010/01/12.
add doc/go-logo-white.png.

R=r
CC=golang-dev
https://golang.org/cl/186132
2010-01-13 16:26:22 -08:00
Robert Griesemer
27be2915f3 Distinguish between html generation and html quoting in godoc formatters.
Replacement for CL 184084; originally by Roger Peppe (rogpeppe@gmail.com).

R=rsc
CC=golang-dev, rog
https://golang.org/cl/189059
2010-01-13 15:18:56 -08:00
Russ Cox
1c6c0eee20 godoc: skip template wrapping for complete HTML files
demo at http://wreck:8080/doc/
click on go_talk-20100112.html

R=gri
CC=golang-dev
https://golang.org/cl/186137
2010-01-13 13:09:33 -08:00
Russ Cox
c918c41c58 add doc/devel/index.html, linked from nav bar
R=r
CC=golang-dev
https://golang.org/cl/181156
2010-01-07 18:23:41 -08:00
Russ Cox
d55abfd2c9 doc: split contribute.html into code.html and contribute.html
R=r
https://golang.org/cl/170042
2009-12-09 14:05:12 -08:00
Robert Griesemer
9e450880e9 some godoc cleanup:
- simplified dealing with parse errors: no need to intersperse them in the source
- improve visibility of highlighted identifiers by showing them in bold

R=rsc
https://golang.org/cl/163051
2009-12-01 09:15:05 -08:00
Robert Griesemer
af872b2ba4 Add id attribute to h2 and h3 tags so that they exist when referring
to generated pages even if Javascript has not introduced them yet.

R=rsc
https://golang.org/cl/154167
2009-11-16 15:25:16 -08:00
Russ Cox
c8bb81fddc video is ready
R=r
http://codereview.prom.corp.google.com/1024050
2009-11-10 17:05:07 -08:00
Russ Cox
8a902ed840 video is coming soon
R=r
http://go/go-review/1024049
2009-11-10 14:47:23 -08:00
Russ Cox
78c47c36b2 update video links
R=r
http://go/go-review/1024048
2009-11-10 14:09:01 -08:00
Russ Cox
4414442442 remove internal references from doc/install.html
and doc/contribute.html.

add #go-nuts to help section on nav bar.

R=r
http://go/go-review/1025035
2009-11-10 09:37:03 -08:00
Robert Griesemer
a10e2051ae - add .. link to package directory listing, for easy traversal
- matches style of source file directory listing

R=rsc
http://go/go-review/1024044
2009-11-09 23:22:04 -08:00
Robert Griesemer
c110269579 cleanup style:
- consistently remove all underbars from links
- this removes need for noline style
- removed unused info style

R=r, rsc
http://go/go-review/1025032
2009-11-09 16:19:38 -08:00
Robert Griesemer
93c3f5124e make search box ever so slightly wider
R=rsc
http://go/go-review/1024036
2009-11-09 14:49:01 -08:00
Robert Griesemer
568c018fee make search box width dynamically sized
R=rsc, agl
http://go/go-review/1024032
2009-11-09 10:27:07 -08:00
Robert Griesemer
d731dc8e72 Addressing issue brought up by dsymonds:
- When providing alternative spellings to a query, do not
  prefix it with a package qualifier as the suggestion may
  not have any results. Correctly filtering is quite a bit
  of work, and clicking the alternative spelling will always
  also show the qualified hits if they exist (but also others).
  Seems good enough for now.
- Give user feedback when the query syntax was wrong.
- Package names in search results are now links to the respective
  package documentation.
- Experimented with excluding main packages and test files
  from index with inconclusive results. Code is present and
  can be enabled by changing a flag in the source. This needs
  some more work.

R=rsc
CC=r, dsymonds
http://go/go-review/1026033
2009-11-08 23:34:08 -08:00
Robert Griesemer
7837dbfcb8 use grouping instead of colors to show non-global search hits:
- introduced a new run per file containing all spots belonging
  to the same kind (e.g. var decl, const decl, etc.)
- more comments, better index.go file organization

R=rsc
http://go/go-review/1026028
2009-11-08 20:17:04 -08:00
Robert Griesemer
202ede1240 - properly align package synopses
(this was surprisingly hard to get right in HTML)
- show modification times in source directory listings
- various tweaks

R=rsc
http://go/go-review/1024024
2009-11-08 16:47:32 -08:00
Russ Cox
826e10ce64 links to Go Nuts, issue tracker,
source code browser on code.google.com
(where LICENSE file is visible)

R=r
http://go/go-review/1024023
2009-11-08 09:50:16 -08:00
Robert Griesemer
a011480ff3 TBR
1st step of renaming dirList.html -> dirlist.html
(OS X filenames are not capitalization-sensitive)

R=rsc
http://go/go-review/1024021
2009-11-08 00:51:08 -08:00
Robert Griesemer
5de21eb1e9 TBR
step 2: adding renamed dirlist.html again

R=rsc
http://go/go-review/1024022
2009-11-08 00:49:56 -08:00
Robert Griesemer
642caacfa3 - added link to sources
- renamed listing.html -> dirList.html
  (there is a dirs.html already, it should probably have a better name, too)

R=rsc
http://go/go-review/1025020
2009-11-07 21:24:48 -08:00
Robert Griesemer
171ef39949 nice directory listings
R=rsc
http://go/go-review/1026020
2009-11-07 21:12:46 -08:00
Russ Cox
213bd39a3b fix a few style nits; arrange the doc list in
an order we want people to read the docs.

R=r
CC=go-dev
http://go/go-review/1025017
2009-11-07 16:46:49 -08:00
Robert Griesemer
1ac60ddd10 - support to extract one-line package synopsis for package listings
- formatting in dirs.html is crude, needs better html (open to suggestions),
  but shows the synopsis
- many package comments should probably be adjusted such that the first
  sentence is more concise

R=rsc, iant
http://go/go-review/1025014
2009-11-07 13:17:53 -08:00
Russ Cox
b94f8131ae new style; live at http://r45:3456/
R=r
CC=go-dev
http://go/go-review/1026015
2009-11-07 12:11:28 -08:00
Rob Pike
f93ecca397 add a place-holder link for the hour-long video
R=rsc
CC=go-dev
http://go/go-review/1017054
2009-11-05 13:46:12 -08:00
Adam Langley
51c1bd229b godoc: style update.
R=r, rsc
CC=go-dev
http://go/go-review/1017051
2009-11-05 12:18:54 -08:00
Robert Griesemer
d06dc14aa8 remove "em" unit from td width specification
R=rsc
http://go/go-review/1018037
2009-11-04 10:58:13 -08:00
Adam Langley
b9ec2adfc7 Update the styling of the godoc pages.
(root.html is just temporary. It'll need some better content.)

R=r
CC=go-dev
http://go/go-review/1017019
2009-11-03 19:59:45 -08:00
Robert Griesemer
4818d346b6 support for command documentation:
- made package tree handler generic so it can work on any fs tree
- cleanups along the way

R=rsc
CC=r
http://go/go-review/1017020
2009-11-03 19:40:26 -08:00
Robert Griesemer
be56b95770 - show recursive package directory structure in package pages
- removed some underbars in section headings for better looks
- various minor tweaks

R=rsc
http://go/go-review/1018026
2009-11-02 22:44:01 -08:00
Robert Griesemer
49d295d592 - initial steps towards showing directory tree instead of
just a single directory
- all pieces present but not well integrated
- directory tree served at the moment under /tree

R=rsc
http://go/go-review/1018016
2009-11-02 09:25:39 -08:00
Robert Griesemer
c54cb4cb4d - added missing formatters in templates
- replaced deprecated use of </font> with </span> tag
- added html escaping to godoc formatters where missing
- enabled text format for package documentation

R=rsc
http://go/go-review/1017001
2009-10-28 16:19:09 -07:00