go-ceph icon indicating copy to clipboard operation
go-ceph copied to clipboard

Docs on pkg.go.dev don't have preview tag set

Open ansiwen opened this issue 3 years ago • 2 comments

The doc generation doesn't know that we use a preview tag, so all preview APIs are not documented there. We need to investigate, if we can set default tags for docs or something similar.

ansiwen avatar Oct 15 '21 10:10 ansiwen

Probably relevant: https://github.com/golang/go/issues/34409 https://github.com/golang/go/issues/45497

From what I see there's no easy way out. Options that are valid today are pretty limited. I wish the Go ecosystem liked static doc generation more, because then we could host our own version of the documentation with certain build tags enabled or a matrix of ceph version build tags, etc. But right now it seems that neither the official site works for this use case nor are there good offline doc generation tools for Go.

phlogistonjohn avatar Nov 01 '21 14:11 phlogistonjohn

More searching around wrt to the idea of generating static docs lead me to find https://github.com/readthedocs/godocjson and https://bitbucket.org/ymotongpoo/sphinxcontrib-golangdomain/src/master/ both of which look rather unmaintained. However, that doesn't necessarily mean they don't work. I haven't tried it.

phlogistonjohn avatar Nov 01 '21 14:11 phlogistonjohn