Skip to content

Exposed docs for compile_pip_requirements - #534

Merged
alexeagle merged 2 commits into
bazel-contrib:mainfrom
UebelAndre:compile
Sep 28, 2021
Merged

Exposed docs for compile_pip_requirements#534
alexeagle merged 2 commits into
bazel-contrib:mainfrom
UebelAndre:compile

Conversation

@UebelAndre

@UebelAndre UebelAndre commented Sep 14, 2021

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

  • Does not include precompiled binaries, eg. .par files. See CONTRIBUTING.md for info
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature (please, look at the "Scope of the project" section in the README.md file)
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

compile_pip_requirements is not currently in the docs and seems to otherwise be hidden as a result. This PR fixes that.

Issue Number: N/A

What is the new behavior?

compile_pip_requirements can now be loaded via @rules_python//python:pip.bzl which is also used to populate docs/pip.md with the appropriate docs for the rule.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@thundergolfer thundergolfer left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Broadly LGTM. Pulls the compile_pip_requirements macro into the main packaging rules namespace, so bringing in @alexeagle to review.

@alexeagle alexeagle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, good time to give the docs some love

@alexeagle
alexeagle merged commit fede517 into bazel-contrib:main Sep 28, 2021
@UebelAndre
UebelAndre deleted the compile branch November 28, 2021 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants