Skip to content
New issue

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

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

Already on GitHub? # to your account

[Docs] Drop duplicate [source] links #12780

Merged
merged 1 commit into from
Feb 5, 2025

Conversation

russellb
Copy link
Member

@russellb russellb commented Feb 5, 2025

A prior change, #10672, added new [source] links for github. The old
links were left in place to ensure that that new github links were
working well before we removed them.

The github links seem to be working well, so we can now remove the
links to custom HTML pages of source code.

To do this, we just drop the sphinx.ext.viewcode extension. We will
now rely only on sphinx.ext.linkcode, which uses code in conf.py
to generate source code links.

Signed-off-by: Russell Bryant rbryant@redhat.com

A prior change, vllm-project#10672, added new `[source]` links for github. The old
links were left in place to ensure that that new github links were
working well before we removed them.

The github links seem to be working well, so we can now remove the
links to custom HTML pages of source code.

To do this, we just drop the `sphinx.ext.viewcode` extension. We will
now rely only on `sphinx.ext.linkcode`, which uses code in `conf.py`
to generate source code links.

Signed-off-by: Russell Bryant <rbryant@redhat.com>
Copy link

github-actions bot commented Feb 5, 2025

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label Feb 5, 2025
@DarkLight1337 DarkLight1337 enabled auto-merge (squash) February 5, 2025 15:18
@DarkLight1337
Copy link
Member

Thanks for the update!

@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Feb 5, 2025
@simon-mo simon-mo merged commit 9a5b155 into vllm-project:main Feb 5, 2025
36 of 43 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants