-
|
Hi, I was looking at https://github.com/agoessling/rules_sphinx to move it to bzlmod. While doing so I figured out that the sphinx integration implemented by rules_python is way more advanced (and feature complete). I get some mixed signals when looking at So my question is: is it intended and Thanks! |
Beta Was this translation helpful? Give feedback.
Replies: 3 comments · 1 reply
-
|
The main intention was to not expose an API prematurely. I personaly would love to see this reused in other projects and rules_testing could use this too. I think if you would be willing to give us feedback on what works and what doesn't and potentially help by contributing PRs if you have the time/willingness, then it would be definitely very appreciated. But befare deciding on how we proceed, let's see what @rickeylev has to say. |
Beta Was this translation helpful? Give feedback.
-
|
Sure! First usage was really pleasant! I will test it a little more for our use-cases and can provide either feedback here or in form of issues (what you guys prefer). |
Beta Was this translation helpful? Give feedback.
-
|
Yeah, I'm fine with exposing it publicly as an unsupported/experimental API. I want to move rules_testing over to it, too. We can change those visibility settings to public and add some doc disclaimers about them.
Thanks 😁! What language(s) are you generating docs for? |
Beta Was this translation helpful? Give feedback.
-
OK. I will prepare a PR.
We mainly use Sphinx to generate higher-level documentation (e.g. user-documentation, how-to guides, ...). But we also have C++ and Python code, but honestly did not yet generate docs for it with thinks. That might be a next interesting step! |
Beta Was this translation helpful? Give feedback.
The main intention was to not expose an API prematurely. I personaly would love to see this reused in other projects and rules_testing could use this too.
I think if you would be willing to give us feedback on what works and what doesn't and potentially help by contributing PRs if you have the time/willingness, then it would be definitely very appreciated.
But befare deciding on how we proceed, let's see what @rickeylev has to say.