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

Improve code block CSS in libcu++ docs #1483

Merged
merged 2 commits into from
Mar 5, 2024

Conversation

Nyrio
Copy link
Contributor

@Nyrio Nyrio commented Mar 4, 2024

Description

closes #1481

This PR improves the readability of code blocks in the libcu++ docs by:

  • Removing a rule that sets the text background instead of the block background.
  • Adding a rule for a darker background for code blocks.

Before:

css_before

After:

css_after_2

Notes:

  • To override some defaults outside the project, I used a more specific selector.
  • Local docs building is still broken, see [DOC]: Instructions for hosting docs locally don't work #1309
  • I used the color #1a1a1a because I find that #111111 is too high contrast. Most code editors use lower-contrast themes for better readability.

@Nyrio Nyrio requested review from a team as code owners March 4, 2024 21:30
@Nyrio Nyrio requested review from miscco and alliepiper March 4, 2024 21:30
Copy link

copy-pr-bot bot commented Mar 4, 2024

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

Copy link
Collaborator

@miscco miscco left a comment

Choose a reason for hiding this comment

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

Looks great to me.

I also like the new background color a lot better than the old one

@miscco miscco requested a review from jrhemstad March 5, 2024 07:29
@miscco
Copy link
Collaborator

miscco commented Mar 5, 2024

/ok to test

@miscco miscco added doc Documentation-related items. area: docs labels Mar 5, 2024
Copy link
Contributor

@ahendriksen ahendriksen left a comment

Choose a reason for hiding this comment

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

Thanks! An aesthetic improvement is always welcome :)

@jrhemstad
Copy link
Collaborator

Thanks @Nyrio ! This is much better. We've been dragging our feet on fixing this because we're planning on updating the libcudacxx docs to use the same Sphinx template as the CUB docs, but this is a major improvement in the meantime :)

@miscco miscco merged commit 374d0d0 into NVIDIA:main Mar 5, 2024
586 checks passed
@miscco
Copy link
Collaborator

miscco commented Mar 5, 2024

Thanks a lot for making our documentation more readable 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs doc Documentation-related items.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[DOC]: Code blocks in libcu++ docs are hard to read
4 participants