Skip to content

Commit 1d6eb23

Browse files
authored
fix(internal/godocfx): add TOC element for module root package (#3599)
1 parent ae96dcb commit 1d6eb23

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

internal/godocfx/parse.go

+8-1
Original file line numberDiff line numberDiff line change
@@ -339,9 +339,16 @@ func buildTOC(mod string, pis []pkgInfo, extraFiles []extraFile) tableOfContents
339339
toc := tableOfContents{}
340340

341341
modTOC := &tocItem{
342-
UID: mod, // Assume the module root has a package.
342+
UID: mod,
343343
Name: mod,
344344
}
345+
346+
// Assume the module root has a package.
347+
modTOC.addItem(&tocItem{
348+
UID: mod,
349+
Name: mod,
350+
})
351+
345352
for _, ef := range extraFiles {
346353
modTOC.addItem(&tocItem{
347354
Href: ef.dstRelativePath,

internal/godocfx/testdata/golden/toc.yml

+2
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
- uid: cloud.google.com/go/storage
33
name: cloud.google.com/go/storage
44
items:
5+
- uid: cloud.google.com/go/storage
6+
name: cloud.google.com/go/storage
57
- name: README
68
href: pkg-readme.md

0 commit comments

Comments
 (0)