fix(sphinxdocs),deps: allow using sphinx_stardoc with bzlmod; add stardoc 0.6.2 as dependency#2295
Merged
rickeylev merged 3 commits intobazel-contrib:mainfrom Oct 15, 2024
Conversation
Using the sphinx_stardoc rule doesn't work with bzlmod because it refers to the stardoc repo, which was a dev dependency. This means, even if a user's root module has visibility to stardoc, rules_python doesn't. To fix, make stardoc a non-dev dependency. With bzlmod semantics, stardoc won't actually be loaded unless a user depends on it by using sphinxdocs.
aignas
approved these changes
Oct 13, 2024
Collaborator
aignas
left a comment
There was a problem hiding this comment.
Should we add a note in the docs? I think this may force users onto a newer version of stardoc in their own setup.
…o fix.sphinxdocs.bzlmod.external.usage
Collaborator
Author
|
Good point. Done. It'd be nice to be able to avoid it as a non-dev dependency, but I couldn't figure out any clean way to do so. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Using the sphinx_stardoc rule doesn't work with bzlmod because it refers to the stardoc repo, which was a dev dependency. This means, even if a user's root module has visibility to stardoc, rules_python doesn't.
To fix, make stardoc a non-dev dependency. With bzlmod semantics, stardoc won't actually be loaded unless a user depends on it by using sphinxdocs.
I ran into this while trying to port rules_testing over to sphinxdocs. The pigweed project
recently started using sphinxdocs and didn't run into this problem, but I'm pretty
sure that's because they're using workspace still, which doesn't have the visibility
constraints that bzlmod does.