Skip to content

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

Closed
wants to merge 2 commits into from

Conversation

houllette
Copy link

@houllette houllette commented Oct 1, 2018

Fixes #4698

Copy link
Contributor

@davidfischer davidfischer left a 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
Copy link
Contributor

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

Copy link
Author

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
Copy link
Contributor

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
Copy link
Contributor

Choose a reason for hiding this comment

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

And here

@stsewd
Copy link
Member

stsewd commented Oct 1, 2018

@houllette you can run the docs linter locally with tox -e docs-lint

@humitos
Copy link
Member

humitos commented Oct 14, 2018

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/

@humitos
Copy link
Member

humitos commented Nov 13, 2018

@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 😄

@RichardLitt RichardLitt added the Needed: more information A reply from issue author is required label Nov 13, 2018
@dojutsu-user
Copy link
Member

dojutsu-user commented Dec 8, 2018

@humitos
If possible, I would like to send a new PR. I just tried your idea and it works fine.

Link to the test docs page - https://template-dojutsu-user.readthedocs.io/en/latest/usage.html
Link to the test repo fle - https://github.com/dojutsu-user/template/blob/master/docs/usage.rst

@humitos
Copy link
Member

humitos commented Dec 11, 2018

@dojutsu-user please, go ahead! I think @houllette is not working on this issue anymore.

@humitos
Copy link
Member

humitos commented Jan 9, 2019

Closing this PR in favor of #4990

@humitos humitos closed this Jan 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: more information A reply from issue author is required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants