1
0
mirror of https://github.com/golang/go synced 2024-11-22 08:54:39 -07:00
go/lib/godoc
Russ Cox cb2f6cb05d godoc: generate package toc in template, not in JavaScript
1. Generate TOC for package pages using template,
instead of using JavaScript magic.  This makes the
pages generated by godoc -html easier to export
to other systems.

2. Make TOC one column.  It's hard to do two columns
portably without invoking JavaScript.

3. Since the TOC is only one column, show full type
signatures for functions and methods.  Many times
that's all you need to see anyway.

4. Name the section after the TOC "Overview".
Naming it something is important, to set it off
from the TOC and so that there's a quick link to
it in the TOC.

For now, some illustrative examples:

http://swtch.com:6060/pkg/io/
http://swtch.com:6060/pkg/strings/
http://swtch.com:6060/pkg/tabwriter/
http://swtch.com:6060/pkg/unicode/

Fixes #1982.

R=gri, bradfitz, r
CC=golang-dev
https://golang.org/cl/5303044
2011-10-18 16:23:35 -04:00
..
codewalk.html exp/template: rename filter: url -> urlquery. 2011-08-13 14:00:16 +10:00
codewalkdir.html godoc: template cleanup 2011-08-17 16:38:58 -07:00
dirlist.html godoc: template cleanup 2011-08-17 16:38:58 -07:00
error.html godoc: first round of template cleanups 2011-08-12 10:06:32 -07:00
example.html go/doc, godoc, gotest: support for reading example documentation 2011-10-06 11:56:17 -07:00
godoc.html godoc: fix godoc.html template bug: correctly display package roots 2011-08-14 08:56:47 +10:00
package.html godoc: generate package toc in template, not in JavaScript 2011-10-18 16:23:35 -04:00
package.txt godoc: fix lib/godoc/package.txt template 2011-08-15 15:42:27 -07:00
search.html godoc: show packages matching a query at the top 2011-09-08 15:35:56 -07:00
search.txt godoc: fine tuning of template file 2011-09-08 18:27:26 -07:00