Skip to content

[Docs] Migrate from Sphinx to MkDocs #189

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 13 commits into from
Jun 2, 2025
Merged

[Docs] Migrate from Sphinx to MkDocs #189

merged 13 commits into from
Jun 2, 2025

Conversation

rafvasq
Copy link
Collaborator

@rafvasq rafvasq commented May 30, 2025

rafvasq added 4 commits May 30, 2025 13:59
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
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 🚀

rafvasq added 6 commits May 30, 2025 14:28
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
@rafvasq rafvasq force-pushed the migrate-docs branch 2 times, most recently from d913157 to 09cbe17 Compare June 2, 2025 16:27
rafvasq added 2 commits June 2, 2025 12:29
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
@rafvasq rafvasq requested a review from prashantgupta24 June 2, 2025 16:42
@@ -1,6 +1,6 @@
# Configuration

For a complete list of configuration options, see <project:./env_vars.md>.
For a complete list of configuration options, see [Environment Variables](env_vars.md).
Copy link
Collaborator

Choose a reason for hiding this comment

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

I like this way better!

mkdocs.yaml Outdated
theme:
name: material
# logo: assets/logos/vllm-logo-only-light.ico
# favicon: assets/logos/vllm-logo-only-light.ico
Copy link
Collaborator

Choose a reason for hiding this comment

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

do we still want these 2 commented lines?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Removed ✅

Copy link
Collaborator

@prashantgupta24 prashantgupta24 left a comment

Choose a reason for hiding this comment

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

LGTM! Some questions/nits

Signed-off-by: Rafael Vasquez <[email protected]>
@rafvasq rafvasq enabled auto-merge (squash) June 2, 2025 18:51
@github-actions github-actions bot added the ready label Jun 2, 2025
@rafvasq rafvasq merged commit 6e75bde into main Jun 2, 2025
21 of 22 checks passed
@rafvasq rafvasq deleted the migrate-docs branch June 2, 2025 19:00
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.

2 participants