Skip to content

[Bugfix] Remove mandatory flash-attn dependency and optimzie docs#113

Merged
tzhouam merged 3 commits intovllm-project:mainfrom
Gaohan123:flash-attn-fix
Nov 30, 2025
Merged

[Bugfix] Remove mandatory flash-attn dependency and optimzie docs#113
tzhouam merged 3 commits intovllm-project:mainfrom
Gaohan123:flash-attn-fix

Conversation

@Gaohan123
Copy link
Collaborator

Purpose

This PR removes mandatory flash-attn dependency and optimzie docs. Now it can automatically link markdown file in examples to docs and navigation.

Test Plan

Follow README.md in examples of Qwen3-omni.

Test Result


Essential Elements of an Effective PR Description Checklist
  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.
  • (Optional) Release notes update. If your change is user facing, please update the release notes draft.

BEFORE SUBMITTING, PLEASE READ https://github.com/vllm-project/vllm-omni/blob/main/CONTRIBUTING.md (anything written below this line will be removed by GitHub Actions)

@Gaohan123 Gaohan123 added the bug Something isn't working label Nov 30, 2025
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment on lines +14 to +18
ROOT_DIR = Path(__file__).parent.parent.parent.parent
ROOT_DIR_RELATIVE = "../../../../.."
EXAMPLE_DIR = ROOT_DIR / "examples"
EXAMPLE_DOC_DIR = ROOT_DIR / "docs/user_guide/examples"
NAV_FILE = ROOT_DIR / "docs/.nav.yml"

Choose a reason for hiding this comment

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

P1 Badge Fix docs hook using parent of repo as root

The MkDocs hook computes ROOT_DIR by walking four parents from generate_examples.py, which resolves to /workspace instead of the repository root /workspace/vllm-omni. Consequently EXAMPLE_DIR points to /workspace/examples, and on_startup calls EXAMPLE_DIR.iterdir() (line ~310) on a non-existent path, raising FileNotFoundError and aborting mkdocs build/serve before any example docs or nav updates are generated. Please anchor ROOT_DIR at the repo root so the hook can locate examples and .nav.yml.

Useful? React with 👍 / 👎.

@tzhouam
Copy link
Collaborator

tzhouam commented Nov 30, 2025

lgtm, merging

@tzhouam tzhouam merged commit 88c00fb into vllm-project:main Nov 30, 2025
3 checks passed
princepride pushed a commit to princepride/vllm-omni that referenced this pull request Jan 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants