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] Refactor example gallery to remove temporary flash #37217

Merged
merged 1 commit into from
Jul 10, 2023

Conversation

peytondmurray
Copy link
Contributor

Why are these changes needed?

This PR reworks the docs example gallery to fix an annoying transient state that pops up when the example gallery first loads, before the js that overrides a bunch of default sphinx styles is executed and replaces the content.

This is achieved by directly inserting a link to a stylesheet into the example gallery file instead of loading it via js. This applies styles on first page load rather than whenever js gets around to executing. Other minor changes:

  • Removed a bit of the script that runs on the example gallery that removes content from the site navigation bar on the left of the page. It's unnecessary to modify the DOM; we can just hide these nodes with css, and should speed up rendering.
  • Removed a wildcard import in conf.py; linters don't like these and it's less clear than explicit imports.

Related issue number

Closes #37216.

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 added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • 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: pdmurray <peynmurray@gmail.com>
@peytondmurray peytondmurray requested a review from simran-2797 July 7, 2023 23:28
@peytondmurray peytondmurray requested a review from a team as a code owner July 7, 2023 23:28
@simran-2797
Copy link
Contributor

Awesome! LGTM.

@matthewdeng matthewdeng merged commit 5a187f0 into ray-project:master Jul 10, 2023
angelinalg pushed a commit to angelinalg/ray that referenced this pull request Jul 11, 2023
Bhav00 pushed a commit to Bhav00/ray that referenced this pull request Jul 11, 2023
…#37217)

Signed-off-by: pdmurray <peynmurray@gmail.com>
Signed-off-by: Bhavpreet Singh <singh.bhavpreet00@gmail.com>
bveeramani pushed a commit that referenced this pull request Jul 11, 2023
…7284)

Signed-off-by: pdmurray <peynmurray@gmail.com>
Co-authored-by: Peyton Murray <peynmurray@gmail.com>
NripeshN pushed a commit to NripeshN/ray that referenced this pull request Aug 15, 2023
…#37217)

Signed-off-by: pdmurray <peynmurray@gmail.com>
Signed-off-by: NripeshN <nn2012@hw.ac.uk>
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
…#37217)

Signed-off-by: pdmurray <peynmurray@gmail.com>
Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Example gallery displays transient content before styles are applied
4 participants