error: other declaration of main, when documenting Datadog

[aep-sunlife]

Hi,

Datadog's API is too big for the central https://pkg.go.dev/ service.

I'm trying to use golds as a workaround.

However, the golds evidently struggles to handle Go projects that provide multiple applications.

The golds locks repeat the error other declaration of main dozens of times.

https://github.com/DataDog/datadog-api-client-go

This seems to happen with Go 1.24.1 / 1.24.2, at least on macOS Sequoia.

[zigo101]

The golds locks repeat the error other declaration of main dozens of times.

Golds uses the official "golang.org/x/tools/go/packages" package to parse Go code.
The error is reported by that package.
(It seems Go toolchain also uses that package, so that go build ./... reports the same error).

I haven't got the reason of the error. Golds handles some other projects with multiple main packages well.

Currently, you can exclude the examples packages (use ./api/... as the argument) in building the doc.
Datadog's API is really large. It looks the page https://pkg.go.dev/github.com/DataDog/datadog-api-client-go/v2/api/datadogV2 is generated incomplete.

You can use the following command to start the Golds doc server.

golds -s -compact -render-doclinks -wdpkgs-listing=promoted ./api/...

However, when loading the datadog-api-client-go/v2/api/datadogV2 page,
my computer (8G memory) almost hangs for memory exhausting.
(Go runtime has a big drawback: Go programs don't oom on memory exhausting.)

I used the following command to generate static doc pages:

golds -gen -compact -render-doclinks -wdpkgs-listing=promoted ./api/...

For the same reason (memory exhausting), the build failed,
but the api/datadogV2 page was generated before the build process is CTRL-Ced.
Its size is about 33M.

I tried using GOGC and GOMEMLIMIT env vars to limit Go runtime memory usages,
but it looks the two vars have no effects. I haven't got any clues about this now.

If your computer has a larger memory capacity, you can try the above command.
Just make sure to save all your works before running the command.
(If your computer hangs, you might need to restart it forcefully. :D)

It looks to me the root cause is the page generating code consumes too much memory sometimes.
I will try to locate the root cause when I have a good mood and enough spare time.