rules_python icon indicating copy to clipboard operation
rules_python copied to clipboard

Documentation for bzlmod extensions

Open chrislovecnm opened this issue 2 years ago • 4 comments

We are not creating documentation for the public API for the files under https://github.com/bazelbuild/rules_python/tree/main/python/extensions. I have tried but as of stardoc 0.5.6 extension support does not appear to work.

chrislovecnm avatar Apr 24 '23 16:04 chrislovecnm

It seems that stardoc does not support generating module_extension docs as my experience in #1189 shows. In that PR I have created an initial documentation file for extensions.bzl, which just takes the docstring from the file and puts it in the markdown.

I am not sure if https://github.com/bazelbuild/stardoc/issues/123 is the right issue to track upstream as it does not mention about the docs for module_extension not being generated at all.

aignas avatar May 01 '23 13:05 aignas

FYI - https://github.com/bazelbuild/stardoc/issues/123#issuecomment-1590066933

chrislovecnm avatar Jun 13 '23 21:06 chrislovecnm

Also see https://github.com/bazelbuild/rules_go/blob/master/docs/go/core/bzlmod.md for beautiful documentation

chrislovecnm avatar Jun 13 '23 21:06 chrislovecnm

This issue has been automatically marked as stale because it has not had any activity for 180 days. It will be closed if no further activity occurs in 30 days. Collaborators can add an assignee to keep this open indefinitely. Thanks for your contributions to rules_python!

github-actions[bot] avatar Apr 06 '24 22:04 github-actions[bot]

This issue was automatically closed because it went 30 days without a reply since it was labeled "Can Close?"

github-actions[bot] avatar May 06 '24 22:05 github-actions[bot]