bazel-contrib / bazel-contrib/rules_python

sphinxdocs: allow repo rules to document their environment variables

Open
#3,299 0 comments 0 reactions 0 assignees View on GitHub
sphinxdocs type: feature request
Dominant language
Starlark
Stars
688
Forks
721
Avg merge
15h 7m
Merged PRs (30d)
76

Description

Starting with Bazel 7.1, repository rules can use `repository_ctx.getenv()` to get environment variable values, and they no longer have to be listed in the `environ` attribute of the repo rule.

This makes them hidden from docgen.

A directive or option should be added so that repo rule docs can describe what environment variables they use.

```
:::{repo-rule}
:uses-envvars:
:::

:::{uses-envvar} env-var-name

Description of how its used.
:::
```

In all cases, it xrefs to `.. envvar` directives

Contributor guide

Open the contributing guide

Research direction

Start by tracing the existing `repo-rule`, `envvar`, and docgen directives in the Sphinx documentation system. Determine where directive options and cross-references are implemented, then verify that repository rule documentation can list environment variables and that each `uses-envvar` entry links to the corresponding `envvar` directive.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.