internal/godoc/dochtml/...: remove EnableCommandTOC
It is always true.
Change-Id: I9039b4d77b8bd629e2da4821769565ec9ba43020
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/414395
TryBot-Result: kokoro <noreply+kokoro@google.com>
Reviewed-by: Jamal Carvalho <jamal@golang.org>
Run-TryBot: Jonathan Amsterdam <jba@google.com>
diff --git a/internal/godoc/dochtml/dochtml.go b/internal/godoc/dochtml/dochtml.go
index 6ab63b6..2cca7b3 100644
--- a/internal/godoc/dochtml/dochtml.go
+++ b/internal/godoc/dochtml/dochtml.go
@@ -263,7 +263,6 @@
}
return "/" + versionedPath + search
},
- EnableCommandTOC: true,
})
fileLink := func(name string) safehtml.HTML {
diff --git a/internal/godoc/dochtml/internal/render/linkify.go b/internal/godoc/dochtml/internal/render/linkify.go
index 58ecd96..a08e63d 100644
--- a/internal/godoc/dochtml/internal/render/linkify.go
+++ b/internal/godoc/dochtml/internal/render/linkify.go
@@ -123,7 +123,7 @@
}
}
h := r.blocksToHTML(doc.Content, true, extractLinks)
- if r.enableCommandTOC && len(headings) > 0 {
+ if len(headings) > 0 {
h = safe.HTMLConcat(ExecuteToHTML(tocTemplate, headings), h)
}
return h
diff --git a/internal/godoc/dochtml/internal/render/linkify_test.go b/internal/godoc/dochtml/internal/render/linkify_test.go
index 6a04889..2583405 100644
--- a/internal/godoc/dochtml/internal/render/linkify_test.go
+++ b/internal/godoc/dochtml/internal/render/linkify_test.go
@@ -74,13 +74,20 @@
</p>`,
},
{
- name: "header gets linked",
+ name: "header gets linked 2",
doc: `Documentation.
The Go Project
Go is an open source project.`,
- want: `<p>Documentation.
+ want: `<div role="navigation" aria-label="Table of Contents">
+ <ul class="Documentation-toc">
+ <li class="Documentation-tocItem">
+ <a href="#hdr-The_Go_Project">The Go Project</a>
+ </li>
+ </ul>
+</div>
+<p>Documentation.
</p><h4 id="hdr-The_Go_Project">The Go Project <a class="Documentation-idLink" href="#hdr-The_Go_Project">¶</a></h4><p>Go is an open source project.
</p>`,
},
@@ -150,7 +157,20 @@
name: "Links section is not extracted",
extractLinks: []bool{false},
doc: linksDoc,
- want: `<p>Documentation.
+ want: `<div role="navigation" aria-label="Table of Contents">
+ <ul class="Documentation-toc">
+ <li class="Documentation-tocItem">
+ <a href="#hdr-The_Go_Project">The Go Project</a>
+ </li>
+ <li class="Documentation-tocItem">
+ <a href="#hdr-Links">Links</a>
+ </li>
+ <li class="Documentation-tocItem">
+ <a href="#hdr-Header">Header</a>
+ </li>
+ </ul>
+</div>
+<p>Documentation.
</p><h4 id="hdr-The_Go_Project">The Go Project <a class="Documentation-idLink" href="#hdr-The_Go_Project">¶</a></h4><p>Go is an open source project.
</p><h4 id="hdr-Links">Links <a class="Documentation-idLink" href="#hdr-Links">¶</a></h4><p>- title1, url1
</p><ul class="Documentation-bulletList">
@@ -162,7 +182,17 @@
name: "Links section is extracted",
extractLinks: []bool{true},
doc: linksDoc,
- want: `<p>Documentation.
+ want: `<div role="navigation" aria-label="Table of Contents">
+ <ul class="Documentation-toc">
+ <li class="Documentation-tocItem">
+ <a href="#hdr-The_Go_Project">The Go Project</a>
+ </li>
+ <li class="Documentation-tocItem">
+ <a href="#hdr-Header">Header</a>
+ </li>
+ </ul>
+</div>
+<p>Documentation.
</p><h4 id="hdr-The_Go_Project">The Go Project <a class="Documentation-idLink" href="#hdr-The_Go_Project">¶</a></h4><p>Go is an open source project.
</p><h4 id="hdr-Header">Header <a class="Documentation-idLink" href="#hdr-Header">¶</a></h4><p>More doc.
</p>`,
@@ -599,7 +629,7 @@
</p><h4 id="hdr-Heading_2">Heading 2 <a class="Documentation-idLink" href="#hdr-Heading_2">¶</a></h4><p>More text.
</p>`)
- r := New(context.Background(), nil, pkgTime, &Options{EnableCommandTOC: true})
+ r := New(context.Background(), nil, pkgTime, nil)
got := r.declHTML(doc, nil, false).Doc
if diff := cmp.Diff(want, got, cmp.AllowUnexported(safehtml.HTML{})); diff != "" {
t.Errorf("r.declHTML() mismatch (-want +got)\n%s", diff)
diff --git a/internal/godoc/dochtml/internal/render/render.go b/internal/godoc/dochtml/internal/render/render.go
index f2a75cf..42435d1 100644
--- a/internal/godoc/dochtml/internal/render/render.go
+++ b/internal/godoc/dochtml/internal/render/render.go
@@ -25,15 +25,14 @@
)
type Renderer struct {
- fset *token.FileSet
- pids *packageIDs
- packageURL func(string) string
- enableCommandTOC bool
- ctx context.Context
- docTmpl *template.Template
- exampleTmpl *template.Template
- links []Link // Links removed from package overview to be displayed elsewhere.
- commentParser *comment.Parser
+ fset *token.FileSet
+ pids *packageIDs
+ packageURL func(string) string
+ ctx context.Context
+ docTmpl *template.Template
+ exampleTmpl *template.Template
+ links []Link // Links removed from package overview to be displayed elsewhere.
+ commentParser *comment.Parser
}
type Options struct {
@@ -49,12 +48,6 @@
//
// Only relevant for HTML formatting.
PackageURL func(pkgPath string) (url string)
-
- // EnableCommandTOC turns on the table of contents for the overview section
- // of command pages.
- //
- // Only relevant for HTML formatting.
- EnableCommandTOC bool
}
// docDataTmpl renders documentation. It expects a docData.
@@ -92,7 +85,6 @@
func New(ctx context.Context, fset *token.FileSet, pkg *doc.Package, opts *Options) *Renderer {
var others []*doc.Package
var packageURL func(string) string
- var enableCommandTOC bool
if opts != nil {
if len(opts.RelatedPackages) > 0 {
others = opts.RelatedPackages
@@ -100,19 +92,17 @@
if opts.PackageURL != nil {
packageURL = opts.PackageURL
}
- enableCommandTOC = opts.EnableCommandTOC
}
pids := newPackageIDs(pkg, others...)
return &Renderer{
- fset: fset,
- pids: pids,
- packageURL: packageURL,
- enableCommandTOC: enableCommandTOC,
- docTmpl: docDataTmpl,
- exampleTmpl: exampleTmpl,
- ctx: ctx,
- commentParser: pkg.Parser(),
+ fset: fset,
+ pids: pids,
+ packageURL: packageURL,
+ docTmpl: docDataTmpl,
+ exampleTmpl: exampleTmpl,
+ ctx: ctx,
+ commentParser: pkg.Parser(),
}
}
