-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Removed $ before shell commands in docs #4699
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
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.
This is very close but there's a small issue with one of the literal blocks.
$ sudo apt-get install python-dev | ||
$ sudo apt-get install libevent-dev | ||
$ sudo easy_install pip | ||
sudo apt-get install python-setuptools |
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.
This block is throwing a linting error and isn't formatting correctly. It gets hidden because of other unrelated test failures in master right now (grrr....) but there's definitely an issue here. Here's the link:
https://travis-ci.org/rtfd/readthedocs.org/jobs/435828043
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.
That's no good! I just pushed an update and we'll see if that works, thanks for letting me know!
* Git repo is ``git.corp.company.com:git/docs/documentation.git`` | ||
* Source documents are in ``../docs/source`` | ||
* Sphinx :: | ||
|
||
$ sudo pip install sphinx | ||
sudo pip install sphinx |
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.
The same problem occurs here
|
||
* Git :: | ||
|
||
$ sudo apt-get install git | ||
|
||
sudo apt-get install git |
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.
And here
@houllette you can run the docs linter locally with |
I'd like to go in this direction: "keep the prompt but make it unselectable". This gives us the best of the two worlds. I don't remember where I saw that, but I know that it exists. I did a very simple research and I found this sphinx extension: https://github.com/sbrunner/sphinx-prompt You can see some examples at: https://sbrunner.github.io/sphinx-prompt/ |
@houllette would you like to continue with this PR by following my suggestion from the my latest comment? I'd like to get this merged 😄 |
@humitos Link to the test docs page - |
@dojutsu-user please, go ahead! I think @houllette is not working on this issue anymore. |
Closing this PR in favor of #4990 |
Fixes #4698