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

Remove the input prompt from commands copied from the documentation #458

Open
joaopalmeiro opened this issue Jul 22, 2024 · 0 comments
Open

Comments

@joaopalmeiro
Copy link

Hi! 👋

Problem

At this moment, when copying commands from the documentation (https://jupyterlab-server.readthedocs.io/en/stable/index.html or https://jupyterlab-server.readthedocs.io/en/latest/index.html), such as the commands present on the Config file and command line options page, the $ input prompt is also copied along with the command. In this way, it is not possible to directly run the copied command.

Proposed Solution

Configure the sphinx-copybutton extension so that the $ input prompt is not included in commands copied from the documentation.

The relevant documentation for this configuration can be found in the Strip and configure input prompts for code cells section of the sphinx-copybutton extension documentation.

Another possibility is to remove the $ input prompt directly from the documentation pages.

Additional context

  • Operating System and version: macOS Sonoma 14.5
  • Browser and version: Chrome 126.0.6478.183

Let me know what you think and if I can open a PR. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant