Export all the deps we need for stardoc to work #150
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This enables rulesets that use `rules_license` to be properly documented via `stardoc`. Without this, `stardoc` will fail because the source files for particular rules or providers will not be available.
aiuto
approved these changes
Sep 4, 2024
There was a problem hiding this comment.
LOL. I spent too much time fighting with stardoc yesterday.
This PR is fine, but not really sufficient. Just FYI about the issue
- stardoc has no mechanism to propgate up docstrings from an implementation rule to a wrapper around it (e.g _license vs. license)
- So I built a post processor that does this.
- Somewhere in the recent past, bazel changed so that it never generates docs for any non-external rule, so I can't generate the docs for "_license".
- whump, whump, whump.
I decided to fix that after the 1.0.0. See #151 for WIP on that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This enables rulesets that use
rules_licenseto be properly documented viastardoc. Without this,stardocwill fail because the source files for particular rules or providers will not be available.