-
-
Notifications
You must be signed in to change notification settings - Fork 25.9k
DOC fix behavior of copy button in installation instructions #27052
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 fix behavior of copy button in installation instructions #27052
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks reasonable to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR. I tested on the HTML page rendered by the CI and it seems to work.
However:
I lightly reorganized the shell commands and fix an incorrect linux command (python cvs python3).
The use of the python
command instead of python3
on Linux when using a virtualenv with pip was intentional. Indeed in an activated venv it is expected to always use the python
command, whatever the Python version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean to put my above review in "request changes" mode.
fd12805
to
fae7e61
Compare
I reverted to the previous logic, that is, when a virtual environment is selected, shell commands used to check the installation are identical across operating systems. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM as well. We could probably move the inline prompt1
CSS class to the theme.css
file but let's keep that for another PR.
We could alternatively define a new class (to be added to the parent div) to insert the $
before content on each span using a .prompt-eachline pre
scoped CSS rule instead of having to insert class="prompt1
on each span
tag. We could then probably drop the span
tags in the process.
The I agree this CSS should be internalized, however I don't see a javascript-free way of getting rid of the spans. I will follow-up in another PR. |
Thanks, I was not aware of that. I think it's good enough then (but still feel free to attempt something cleaner in a follow-up if you wish). |
Reference Issues/PRs
Fixes #26948
What does this implement/fix? Explain your changes.
In
doc/install.rst
, the code blocks that contained conditionally displayed shell commands have been replaced with conditionally displayed code blocks.Any other comments?
I lightly reorganized the shell commands and fix an incorrect linux command (python cvs python3).
I am not happy with the HTML code formatting, but this is the best compromise I found dealing with pre-formatted code blocks.