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

[Feature] [Docs] Do not copy line numbers when clicking the clipboard #21968

Closed
1 of 2 tasks
shrekris-anyscale opened this issue Jan 29, 2022 · 6 comments
Closed
1 of 2 tasks
Assignees
Labels
docs An issue or change related to documentation enhancement Request for new feature and/or capability stale The issue is stale. It will be closed within 7 days unless there are further conversation

Comments

@shrekris-anyscale
Copy link
Contributor

Search before asking

  • I had searched in the issues and found no similar feature requirement.

Description

Docs such as this one include code snippets that can be copied by clicking a clipboard pop-up:

clipboard

However, due to updates in the doc formatting, clicking this clipboard now also copies line numbers (that are inserted using :linenos: in the source rst documentation files). The requested feature is to allow users to click this clipboard and copy only the code, not the line numbers.

Use case

This feature makes it easier to follow along coding examples in the documentation.

Related issues

No response

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!
@shrekris-anyscale shrekris-anyscale added enhancement Request for new feature and/or capability docs An issue or change related to documentation labels Jan 29, 2022
@maxpumperla maxpumperla self-assigned this Jan 29, 2022
@maxpumperla
Copy link
Contributor

@shrekris-anyscale very good catch, thanks for spotting this. Should be an easy fix!

@maxpumperla
Copy link
Contributor

ok, so surprisingly enough this seems to be a sphinx >= 4.0 issue, which needs to be patched in downstream themes:

sphinx-doc/sphinx#9363

The RTD theme has fixed it, the book theme might not be aware yet:

readthedocs/sphinx_rtd_theme#1168

@stale
Copy link

stale bot commented May 30, 2022

Hi, I'm a bot from the Ray team :)

To help human contributors to focus on more relevant issues, I will automatically add the stale label to issues that have had no activity for more than 4 months.

If there is no further activity in the 14 days, the issue will be closed!

  • If you'd like to keep the issue open, just leave any comment, and the stale label will be removed!
  • If you'd like to get more attention to the issue, please tag one of Ray's contributors.

You can always ask for help on our discussion forum or Ray's public slack channel.

@stale stale bot added the stale The issue is stale. It will be closed within 7 days unless there are further conversation label May 30, 2022
@shrekris-anyscale
Copy link
Contributor Author

shrekris-anyscale commented Jul 29, 2022

Bumping this issue to remove the stale tag. I believe line numbers still get copied with the clipboard.

@stale stale bot removed the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Jul 29, 2022
@stale
Copy link

stale bot commented Nov 27, 2022

Hi, I'm a bot from the Ray team :)

To help human contributors to focus on more relevant issues, I will automatically add the stale label to issues that have had no activity for more than 4 months.

If there is no further activity in the 14 days, the issue will be closed!

  • If you'd like to keep the issue open, just leave any comment, and the stale label will be removed!
  • If you'd like to get more attention to the issue, please tag one of Ray's contributors.

You can always ask for help on our discussion forum or Ray's public slack channel.

@stale stale bot added the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Nov 27, 2022
@stale
Copy link

stale bot commented Dec 11, 2022

Hi again! The issue will be closed because there has been no more activity in the 14 days since the last message.

Please feel free to reopen or open a new issue if you'd still like it to be addressed.

Again, you can always ask for help on our discussion forum or Ray's public slack channel.

Thanks again for opening the issue!

@stale stale bot closed this as completed Dec 11, 2022
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 enhancement Request for new feature and/or capability stale The issue is stale. It will be closed within 7 days unless there are further conversation
Projects
None yet
Development

No branches or pull requests

2 participants