Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ansiwen opened this issue Oct 15, 2021 · 2 comments
Open

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

ansiwen opened this issue Oct 15, 2021 · 2 comments

Comments

@ansiwen
Copy link
Collaborator

ansiwen commented Oct 15, 2021

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.

@phlogistonjohn
Copy link
Collaborator

Probably relevant:
golang/go#34409
golang/go#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
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants