Bazel Starlark Docs on the Registry
Blog post from Aspect Build
Over the past year, there has been significant progress in generating and publishing API documentation for Bazel modules, particularly through the launch of a new system that centralizes and simplifies this process. Previously, documentation efforts were fragmented across various formats and platforms, leading to inefficiencies and contributor frustration. The new approach integrates documentation generation directly into the Bazel build system using a rule called `starlark_doc_extract`, allowing for seamless creation and publication of API docs alongside module releases in the Bazel Central Registry. This system leverages TypeScript and a Next.js application to render the documentation, avoiding the complexities and dependencies of Java implementations. Contributors are encouraged to enhance this process by updating rulesets to publish their documentation, improving existing documentation with additional examples, and suggesting usability improvements for the UI. The project is managed under the Rules Authors SIG by the Linux Foundation, inviting community participation and collaboration.