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

Generate documentation for module extensions #1919

Open
ylecornec opened this issue Jun 30, 2023 · 1 comment
Open

Generate documentation for module extensions #1919

ylecornec opened this issue Jun 30, 2023 · 1 comment
Labels
blocked Blocked on an usptream ticket P3 minor: not priorized type: documentation

Comments

@ylecornec
Copy link
Member

Stardoc does not seem to handle module extensions yet: bazelbuild/stardoc#123

@ylecornec ylecornec added type: feature request P3 minor: not priorized blocked Blocked on an usptream ticket type: documentation and removed type: feature request labels Jun 30, 2023
@avdv
Copy link
Member

avdv commented Aug 10, 2023

Support for module extensions landed in stardoc 0.6.0 but is only supported by Bazel >= 7 as of now:

When using Bazel 7 or newer (or current Bazel HEAD), Stardoc will by default use the native starlark_doc_extract rule internally (bazelbuild/stardoc#166).

This means, in particular:

You may temporarily disable the new extractor by calling Stardoc with use_starlark_doc_extract = False. However, after Bazel 7 is released, we plan to remove this argument and always use the new extractor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked Blocked on an usptream ticket P3 minor: not priorized type: documentation
Projects
None yet
Development

No branches or pull requests

2 participants