hiro/emacs-ipython-notebook
1
0
Fork 0
mirror of https://github.com/vale981/emacs-ipython-notebook synced 2025-03-06 01:21:38 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improved usage and quick try instructions.

Browse source
This commit is contained in:
John Miller 2017-02-17 15:09:59 -06:00
parent 4f11bffb9e
commit 3614bbcd66
3 changed files with 22 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
_sources/index.rst.txt
View file

@ -214,17 +214,23 @@ Here is the minimal configuration. See customization_ for more details.
Usage
-----
1. Start `IPython notebook server`_.
1. Start the `Jupyter notebook server`_ from the terminal or call ``M-x
ein:jupyter-server-start`` from emacs. Note starting the notebook server from
emacs will automatically call ``ein:jupyter-server-login-and-open``, making
steps 2 and 3 below unnecessary!
2. Hit ``M-x ein:notebooklist-open`` to open notebook list. This will
open :ref:`notebook list <notebook-list-commands>` buffer.
2. If you have token or password authentication enabled then you will need to
call ``M-x ein:notebooklist-login`` and enter the appropriate password.
3. In the notebook list buffer, you can open notebooks by selecting the
3. Hit ``M-x ein:notebooklist-open`` to open notebook list. This will open
:ref:`notebook list <notebook-list-commands>` buffer.
4. In the notebook list buffer, you can open notebooks by selecting the
``[Open]`` buttons. See the :ref:`notebook <notebook-commands>` section for
operations and commands available in the notebook buffer.
.. _`IPython notebook server`:
http://ipython.org/ipython-doc/stable/interactive/htmlnotebook.html
.. _`Jupyter notebook server`:
https://jupyter.readthedocs.io/en/latest/running.html
Commands/Keybinds

13
index.html
View file

@ -340,9 +340,14 @@ don&#8217;t use that optional package.</p>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<ol class="arabic simple">
<li>Start <a class="reference external" href="http://ipython.org/ipython-doc/stable/interactive/htmlnotebook.html">IPython notebook server</a>.</li>
<li>Hit <code class="docutils literal"><span class="pre">M-x</span> <span class="pre">ein:notebooklist-open</span></code> to open notebook list. This will
open <a class="reference internal" href="#notebook-list-commands"><span class="std std-ref">notebook list</span></a> buffer.</li>
<li>Start the <a class="reference external" href="https://jupyter.readthedocs.io/en/latest/running.html">Jupyter notebook server</a> from the terminal or call <code class="docutils literal"><span class="pre">M-x</span>
<span class="pre">ein:jupyter-server-start</span></code> from emacs. Note starting the notebook server from
emacs will automatically call <code class="docutils literal"><span class="pre">ein:jupyter-server-login-and-open</span></code>, making
steps 2 and 3 below unnecessary!</li>
<li>If you have token or password authentication enabled then you will need to
call <code class="docutils literal"><span class="pre">M-x</span> <span class="pre">ein:notebooklist-login</span></code> and enter the appropriate password.</li>
<li>Hit <code class="docutils literal"><span class="pre">M-x</span> <span class="pre">ein:notebooklist-open</span></code> to open notebook list. This will open
<a class="reference internal" href="#notebook-list-commands"><span class="std std-ref">notebook list</span></a> buffer.</li>
<li>In the notebook list buffer, you can open notebooks by selecting the
<code class="docutils literal"><span class="pre">[Open]</span></code> buttons. See the <a class="reference internal" href="#notebook-commands"><span class="std std-ref">notebook</span></a> section for
operations and commands available in the notebook buffer.</li>
@ -419,7 +424,7 @@ Notebook is specified by a string NBPATH whose format is
<dl class="function">
<dt id="ein:notebooklist-login">
<em class="property">function </em><span class="sig-paren">(</span><code class="descname">ein:notebooklist-login </code><em>url-or-port</em> <em>password</em><span class="sig-paren">)</span><a class="headerlink" href="#ein:notebooklist-login" title="Permalink to this definition"></a></dt>
<em class="property">function </em><span class="sig-paren">(</span><code class="descname">ein:notebooklist-login </code><em>url-or-port</em> <em>password</em> <em>&amp;optional</em> <em>retry-p</em><span class="sig-paren">)</span><a class="headerlink" href="#ein:notebooklist-login" title="Permalink to this definition"></a></dt>
<dd><p>Login to IPython notebook server.</p>
</dd></dl>

2
searchindex.js
View file

File diff suppressed because one or more lines are too long