From 8be7a986838c3f51f0efa2d875673ef83e5f5223 2013-11-02 02:14:09 From: Thomas Kluyver Date: 2013-11-02 02:14:09 Subject: [PATCH] Miscellaneous doc fixes --- diff --git a/docs/source/config/extensions/storemagic.rst b/docs/source/config/extensions/storemagic.rst index 1698104..5037e3d 100644 --- a/docs/source/config/extensions/storemagic.rst +++ b/docs/source/config/extensions/storemagic.rst @@ -5,4 +5,5 @@ storemagic ========== .. automodule:: IPython.extensions.storemagic - :members: store + +.. automethod:: StoreMagics.store diff --git a/docs/source/interactive/notebook.rst b/docs/source/interactive/notebook.rst index 7867730..8e18de7 100644 --- a/docs/source/interactive/notebook.rst +++ b/docs/source/interactive/notebook.rst @@ -470,7 +470,7 @@ all the code in the ``.py`` file. You can later manually partition this into individual cells using the ``Edit | Split Cell`` menu option, or the :kbd:`Ctrl-m -` keyboard shortcut. -Note that ``.py`` scripts obtained from a notebook document using nbconvert_ +Note that ``.py`` scripts obtained from a notebook document using :doc:`nbconvert ` maintain the structure of the notebook in comments. Reimporting such a script back into a notebook will preserve this structure. diff --git a/docs/source/interactive/public_server.rst b/docs/source/interactive/public_server.rst index 7e8ff97..7382a0a 100644 --- a/docs/source/interactive/public_server.rst +++ b/docs/source/interactive/public_server.rst @@ -1,4 +1,4 @@ -.. _working_remotely.txt +.. _working_remotely: Running a notebook server ========================= diff --git a/docs/source/interactive/qtconsole.rst b/docs/source/interactive/qtconsole.rst index da63964..d90e67d 100644 --- a/docs/source/interactive/qtconsole.rst +++ b/docs/source/interactive/qtconsole.rst @@ -10,7 +10,7 @@ largely feels like a terminal, but provides a number of enhancements only possible in a GUI, such as inline figures, proper multiline editing with syntax highlighting, graphical calltips, and much more. -.. figure:: ../../_images/qtconsole.png +.. figure:: ../_images/qtconsole.png :width: 400px :alt: IPython Qt console with embedded plots :align: center diff --git a/docs/source/parallel/parallel_intro.rst b/docs/source/parallel/parallel_intro.rst index 719ab74..794d8bc 100644 --- a/docs/source/parallel/parallel_intro.rst +++ b/docs/source/parallel/parallel_intro.rst @@ -224,6 +224,7 @@ on the cluster. An example of ipcontroller-client.json, as created by:: "ssh":"login.mycluster.com", "location":"10.0.0.2" } + More details of how these JSON files are used are given below. A detailed description of the security model and its implementation in IPython