Skip to content

[docs] Add install from PyPI to docs #327

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 20 commits into from
Jul 23, 2025

Conversation

ckadner
Copy link
Collaborator

@ckadner ckadner commented Jul 21, 2025

Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@ckadner ckadner requested a review from rafvasq as a code owner July 21, 2025 16:36
Copy link

👋 Hi! Thank you for contributing to vLLM support on Spyre.
Just a reminder: Make sure that your code passes all the linting checks, otherwise your PR won't be able to be merged. To do so, first install the linting requirements, then run format.sh and commit the changes. This can be done with uv directly:

uv sync --frozen --group lint --active --inexact

Or this can be done with pip:

uv pip compile --group lint > requirements-lint.txt
pip install -r requirements-lint.txt
bash format.sh

Now you are good to go 🚀

ckadner added 3 commits July 21, 2025 09:44
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@ckadner ckadner requested a review from joerunde as a code owner July 21, 2025 16:56
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@ckadner ckadner requested a review from prashantgupta24 as a code owner July 21, 2025 17:05
ckadner added 3 commits July 21, 2025 10:10
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@ckadner ckadner changed the title Add install from PyPI to docs [docs] Add install from PyPI to docs Jul 21, 2025
@ckadner ckadner added documentation Improvements or additions to documentation ready labels Jul 21, 2025
ckadner added 3 commits July 21, 2025 10:30
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@ckadner
Copy link
Collaborator Author

ckadner commented Jul 21, 2025

@joerunde @rafvasq -- should be good to review now 🙏🏻

Rendered changes: https://vllm-spyre--327.org.readthedocs.build/en/327/getting_started/installation.html

Thank you!

@ckadner ckadner enabled auto-merge (squash) July 21, 2025 17:50
ckadner added 2 commits July 21, 2025 18:05
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
BadPluginError encountered while scanning 'docs/getting_started/installation.md':
(45,1): Plugin id 'MD031' had a critical failure during the 'next_token' action.

Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@@ -29,4 +29,4 @@ jobs:
- name: Install dependencies
run: uv sync --frozen --only-group lint
- name: Lint docs
run: tools/lint_docs.sh
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

tools/lint_docs.sh runs both scan and fix -- but during a CI run, changing files to fix lint errors is not needed

ckadner added 2 commits July 22, 2025 13:05
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@ckadner ckadner marked this pull request as draft July 22, 2025 20:12
auto-merge was automatically disabled July 22, 2025 20:12

Pull request was converted to draft

@ckadner ckadner removed the ready label Jul 22, 2025
inline comment (pyml disable-next-line code-block-style) broke tabbed rendering of installation options

Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@ckadner ckadner marked this pull request as ready for review July 22, 2025 20:45
@ckadner ckadner enabled auto-merge (squash) July 22, 2025 20:47
@github-actions github-actions bot added the ready label Jul 22, 2025
@ckadner ckadner requested a review from joerunde July 22, 2025 20:47
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@joerunde
Copy link
Collaborator

Sorry I got distracted after my first comment earlier- This is looking really good!

Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@ckadner ckadner requested a review from joerunde July 22, 2025 22:04
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Copy link
Collaborator

@joerunde joerunde left a comment

Choose a reason for hiding this comment

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

lgtm!

Looks like maybe we've broken something about the test jobs, they're showing up as expected but not running :(

Are they supposed to run but skip all execution when there are only docs changes so the checks pass?

Copy link
Collaborator

@rafvasq rafvasq left a comment

Choose a reason for hiding this comment

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

Mostly nits around using admonitions to highlight certain notes and some typos -- but nothing worth blocking a merge :)

@ckadner
Copy link
Collaborator Author

ckadner commented Jul 23, 2025

Looks like maybe we've broken something about the test jobs, they're showing up as expected but not running :(

Are they supposed to run but skip all execution when there are only docs changes so the checks pass?

Because I touched pyproject.toml, all tests and docker build ran fully (not just the fake quick run) -- with each of my tiny commits -- so I cancelled them to not waste resources. I will make updates to address Rafael's review comments which will trigger a new run of tests and docker build.

Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@ckadner
Copy link
Collaborator Author

ckadner commented Jul 23, 2025

Mostly nits around using admonitions to highlight certain notes and some typos -- but nothing worth blocking a merge :)

Weird, the admonitions do not get rendered in the preview? @rafvasq ?
https://vllm-spyre--327.org.readthedocs.build/en/327/getting_started/installation.html

e.g.:

image

... and expanded:

image

@ckadner ckadner merged commit ccaa01c into vllm-project:main Jul 23, 2025
17 of 18 checks passed
@rafvasq
Copy link
Collaborator

rafvasq commented Jul 23, 2025

@ckadner 🤔 Not sure what you mean since I see them there in the preview and your screenshot?

@ckadner
Copy link
Collaborator Author

ckadner commented Jul 23, 2025

Oh oh, this one auto-merged before @rafvasq could re-review since @joerunde had approved it already earlier but the PR hung around due to the missing required test runs. With the latest commit it triggered the tests again and all checks completed. I should have disabled auto-merge prior to pushing my review updates 😢

@ckadner
Copy link
Collaborator Author

ckadner commented Jul 23, 2025

@ckadner 🤔 Not sure what you mean since I see them there in the preview and your screenshot?

Yeah, must have been a glitch. I see it now as well. Also, live now since it merged. Thank you for your review @rafvasq. It looks much more polished now 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants