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.

Sign up for GitHub

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

Fix pip install problems resulting from non-ASCII in README.rst. #11

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix pip install problems resulting from non-ASCII in README.rst. #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ User guide
==========
Help
----
The standard output for –help::
The standard output for --help::

$ rk -h

Expand All @@ -121,7 +121,7 @@ Example::

Version
-------
The standard output for –version::
The standard output for --version::

$ rk -v

Expand Down Expand Up @@ -155,9 +155,9 @@ Where:

* ``template`` -- the name of a remote jupyter kernel,

* ``display_name`` -- a kernel’s name as it should be displayed in the UI. Unlike the kernel name used in the API, this can contain arbitrary unicode characters [1]_,
* ``display_name`` -- a kernel's name as it should be displayed in the UI. Unlike the kernel name used in the API, this can contain arbitrary unicode characters [1]_,
* ``interpreter`` -- an entry point or an absolute path to language interpreter on a remote machine,
* ``language`` -- a name of the language of a kernel. When loading notebooks, if no matching kernelspec key (may differ across machines) is found, a kernel with a matching language will be used. This allows a notebook written on any python or julia kernel to be properly associated with the user's python or julia kernel, even if they aren’t listed under the same name as the author’s [1]_,
* ``language`` -- a name of the language of a kernel. When loading notebooks, if no matching kernelspec key (may differ across machines) is found, a kernel with a matching language will be used. This allows a notebook written on any python or julia kernel to be properly associated with the user's python or julia kernel, even if they aren't listed under the same name as the author's [1]_,
* ``remote_host`` -- just a remote host or, if your username is different on a remote machine, use this syntax: remote username AT remote host.

.. note:: For checking absolute path to language interpreter on a remote machine use a `which <http://unixhelp.ed.ac.uk/CGI/man-cgi?which>`_ Unix command. For example, for the python3 language on a remote machine: ``$ which python3``.
Expand Down