Skip to content

docs: split PyPI docs up and add more #2935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 29, 2025

Conversation

aignas
Copy link
Collaborator

@aignas aignas commented May 27, 2025

Summary:

  • Split the PyPI docs per topic.
  • Move everything to its own folder.
  • Separate the bzlmod and WORKSPACE documentation. Some of the
    features are only available in bzlmod and since bzlmod is the
    future having that as the default makes things a little easier.
  • Fix a few warnings.

Fixes #2810.

Summary:
- Split the PyPI docs per topic.
- Move everything to its own folder.
- Separate the `bzlmod` and `WORKSPACE` documentation. Some of the
  features are only available in `bzlmod` and since `bzlmod` is the
  future having that as the default makes things a little easier.
- Fix a few warnings.

Fixes bazel-contrib#2810.
As with any repository rule, if you would like to ensure that `pip_parse` is
re-executed to pick up a non-hermetic change to your environment (e.g., updating
your system `python` interpreter), you can force it to re-execute by running
`bazel sync --only [pip_parse name]`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

fyi: i think the command changes under bzlmod? I think its bazel fetch now? I can't remember exactly, though; I rarely use these commands.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, will change this.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I will leave this for now as I could not find the command quickly.

@aignas aignas marked this pull request as ready for review May 28, 2025 08:29
@aignas aignas requested a review from groodt as a code owner May 28, 2025 08:29
@aignas aignas added this pull request to the merge queue May 29, 2025
Merged via the queue into bazel-contrib:main with commit 0d203a9 May 29, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove a stray mention of RULES_PYTHON_OS_ARCH_LOCK_FILE
2 participants