| commit | 2f4687347f601cd3be2d4bacd63d2e261ebb29cd | [log] [tgz] |
|---|---|---|
| author | Richard Levasseur <rlevasseur@google.com> | Sun Aug 25 19:10:30 2024 -0700 |
| committer | GitHub <noreply@github.com> | Mon Aug 26 02:10:30 2024 +0000 |
| tree | 7a1fae8ac46629345009452dfd60f5bba5f0004a | |
| parent | e331afe70524e8ad46d9da6097db1f9c0bfc95c1 [diff] |
docs: docgen python apis (#2149) Uses autodoc2 to generate Python documentation for runfiles and sphinx_bzl. This provides some basic API doc for our Python code. They don't look particularly great, yet, but we can work on how they look in another PR. Also: * Fixes position of license rule and extra space in license text * Forces sphinx_rtd_theme >= 2.0. uv kept trying to downgrade it for some reason. * Use directives markup to document the sphinx_bzl directives * Add `sphinx_run` rule to make it easier to run Sphinx interactively for debugging
This repository is the home of the core Python rules -- py_library, py_binary, py_test, py_proto_library, and related symbols that provide the basis for Python support in Bazel. It also contains package installation rules for integrating with PyPI and other indices.
Documentation for rules_python is at https://rules-python.readthedocs.io and in the Bazel Build Encyclopedia.
Examples live in the examples directory.
The core rules are stable. Their implementation is subject to Bazel's backward compatibility policy. This repository aims to follow semantic versioning.
The Bazel community maintains this repository. Neither Google nor the Bazel team provides support for the code. However, this repository is part of the test suite used to vet new Bazel releases. See How to contribute page for information on our development workflow.
For detailed documentation, see https://rules-python.readthedocs.io
See Bzlmod support for more details.