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] Theme revamp: styling changes #42231

Merged

Conversation

peytondmurray
Copy link
Contributor

@peytondmurray peytondmurray commented Jan 8, 2024

Why are these changes needed?

This PR modifies a few global docs styles and makes index.html use the same pygments-based code highlighting as elsewhere in the docs.

  • Instead of inserting the raw html for index.html using sphinx, I made the index page use its own template. This allows us to pass in a pygments highlighting function to the HTML context, which produces the same code highlighting used elsewhere in the docs.
  • Renamed splash.css -> index.css, splash.js -> index.js

Related issue number

Closes #42052.

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 :(

@peytondmurray peytondmurray added P1 Issue that should be fixed within a few weeks docs An issue or change related to documentation labels Jan 8, 2024
@peytondmurray peytondmurray requested a review from a team as a code owner January 8, 2024 06:01
@peytondmurray peytondmurray requested a review from a team January 10, 2024 02:00
doc/source/conf.py Outdated Show resolved Hide resolved
doc/source/_static/css/index.css Show resolved Hide resolved
doc/source/_templates/index.html Outdated Show resolved Hide resolved
doc/source/conf.py Outdated Show resolved Hide resolved
doc/source/custom_directives.py Outdated Show resolved Hide resolved
@peytondmurray peytondmurray force-pushed the docs-theme-styling-updates branch 3 times, most recently from 724c676 to 880d126 Compare January 10, 2024 19:57
Copy link
Collaborator

@aslonnie aslonnie left a comment

Choose a reason for hiding this comment

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

changes mostly look good.

please address the string quoting styling consistency issue.

@peytondmurray peytondmurray force-pushed the docs-theme-styling-updates branch from 880d126 to 0905dca Compare January 10, 2024 22:30
Signed-off-by: pdmurray <peynmurray@gmail.com>
@peytondmurray peytondmurray force-pushed the docs-theme-styling-updates branch from 0905dca to dbf654f Compare January 10, 2024 22:53
@peytondmurray
Copy link
Contributor Author

Thanks for the feedback, should be ready for merge pending approval from @simran-2797.

@peytondmurray peytondmurray requested a review from a team January 15, 2024 17:49
@aslonnie aslonnie merged commit b8f3f13 into ray-project:master Jan 16, 2024
9 checks passed
@peytondmurray peytondmurray deleted the docs-theme-styling-updates branch January 16, 2024 05:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs An issue or change related to documentation P1 Issue that should be fixed within a few weeks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Ray docs theme revamp: Styling changes
3 participants