Skip to content
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

[Doc] Make front page images non clickable #32738

Merged

Conversation

architkulkarni
Copy link
Contributor

@architkulkarni architkulkarni commented Feb 22, 2023

Why are these changes needed?

A Sphinx issue automatically makes images clickable whenever they're scaled (see https://stackoverflow.com/questions/40096251/disable-click-behavior-for-images). Clicking takes you to a full size version of the image.

On the front page of the docs, there are four prominent images that look like buttons. The user would expect clicking them to take you to a docs page, but instead it just takes you to the image. (See the linked issue for details)

Since there's no single docs page corresponding to each of these four images, in this PR we opt to make these images non clickable.

Related issue number

Closes #32737

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: Archit Kulkarni <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
@architkulkarni architkulkarni marked this pull request as ready for review February 22, 2023 19:17
@architkulkarni architkulkarni requested a review from a team as a code owner February 22, 2023 19:17
@angelinalg
Copy link
Contributor

Thank you for finding and fixing that, @architkulkarni!

Going to assign this to someone in the codeowner group who has more context than me for a review of the code.

@angelinalg angelinalg removed their assignment Feb 22, 2023
@architkulkarni
Copy link
Contributor Author

architkulkarni commented Feb 23, 2023

Screenshot 2023-02-23 at 3 00 26 PM

@architkulkarni
Copy link
Contributor Author

Doc build looks good, non clickable as desired https://ray--32738.org.readthedocs.build/en/32738/

@architkulkarni
Copy link
Contributor Author

@maxpumperla Could you please review this when you get a chance?

@architkulkarni architkulkarni added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Apr 11, 2023
Copy link
Contributor

@maxpumperla maxpumperla left a comment

Choose a reason for hiding this comment

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

thanks!

@architkulkarni architkulkarni merged commit e3594e6 into ray-project:master Apr 12, 2023
elliottower pushed a commit to elliottower/ray that referenced this pull request Apr 22, 2023
A Sphinx issue automatically makes images clickable whenever they're scaled (see https://stackoverflow.com/questions/40096251/disable-click-behavior-for-images). Clicking takes you to a full size version of the image.

On the front page of the docs, there are four prominent images that look like buttons. The user would expect clicking them to take you to a docs page, but instead it just takes you to the image. (See the linked issue for details)

Since there's no single docs page corresponding to each of these four images, in this PR we opt to make these images non clickable.

Signed-off-by: elliottower <[email protected]>
ProjectsByJackHe pushed a commit to ProjectsByJackHe/ray that referenced this pull request May 4, 2023
A Sphinx issue automatically makes images clickable whenever they're scaled (see https://stackoverflow.com/questions/40096251/disable-click-behavior-for-images). Clicking takes you to a full size version of the image.

On the front page of the docs, there are four prominent images that look like buttons. The user would expect clicking them to take you to a docs page, but instead it just takes you to the image. (See the linked issue for details)

Since there's no single docs page corresponding to each of these four images, in this PR we opt to make these images non clickable.

Signed-off-by: Jack He <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tests-ok The tagger certifies test failures are unrelated and assumes personal liability.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Front page big buttons link to images instead of docs pages
3 participants