Skip to content

Make //docs project private visibility #1458

Open
@rickeylev

Description

@rickeylev

The //docs package currently defaults to public visibility, however, the targets within it are just for rules_python to generate its own docs. Other projects shouldn't be relying on the details of how we generate our documentation (especially as I'd like us to move to a generated doc solution like Sphinx so we can have Real Documentation).

From what I can tell, the docs targets are only public so that other projects are able to get the necessary bzl sources for the rules_python bzl code (e.g. //python:defs.bzl) (usually for their own documentation generation), and various filegroups and bzl_libraries were defined in //docs to avoid a dependency on skylib.

We depend on skylib profusely now, so we don't need to worry about that concern.

But, the bzl_library targets in //docs were public targets for a long time, and a Slack thread indicates a couple projects might be pointing to them, so I don't want to just yank them out. I'll put some aliases to make it a bit easier to handle an upgrade.

Metadata

Metadata

Assignees

No one assigned

    Labels

    cleanupTech debt, resolving it improves our own velocity

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions