From 89c4defaf22d74152968daee2364d175ff9c2528 Mon Sep 17 00:00:00 2001 From: Thomas Kluyver Date: Thu, 6 Aug 2015 10:51:51 -0700 Subject: [PATCH] Miscellaneous doc updates and warning-squashing --- docs/source/conf.py | 1 + docs/source/links.txt | 1 + docs/source/notebook.rst | 16 +++++++--------- docs/source/public_server.rst | 8 ++++---- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 8bb2d66617..af209d9013 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -43,6 +43,7 @@ 'sphinx.ext.intersphinx', 'sphinx.ext.autosummary', 'sphinx.ext.mathjax', + 'IPython.sphinxext.ipython_console_highlighting', ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/source/links.txt b/docs/source/links.txt index 70d108ed79..34192d75b3 100644 --- a/docs/source/links.txt +++ b/docs/source/links.txt @@ -27,6 +27,7 @@ .. Other python projects .. _matplotlib: http://matplotlib.org .. _nbviewer: http://nbviewer.jupyter.org +.. _nbconvert: http://nbconvert.readthedocs.org/en/latest/ .. Other tools and projects .. _Markdown: http://daringfireball.net/projects/markdown/syntax diff --git a/docs/source/notebook.rst b/docs/source/notebook.rst index 8bbff06957..d89161262f 100644 --- a/docs/source/notebook.rst +++ b/docs/source/notebook.rst @@ -65,14 +65,14 @@ colleagues. Notebooks may be exported to a range of static formats, including HTML (for example, for blog posts), reStructuredText, LaTeX, PDF, and slide shows, via -the new :ref:`nbconvert ` command. +the nbconvert_ command. Furthermore, any ``.ipynb`` notebook document available from a public URL can be shared via the `Jupyter Notebook Viewer `_ (nbviewer_). This service loads the notebook document from the URL and renders it as a static web page. The results may thus be shared with a colleague, or as a public blog post, without other users needing to install the Jupyter notebook -themselves. In effect, nbviewer_ is simply :ref:`nbconvert ` as +themselves. In effect, nbviewer_ is simply nbconvert_ as a web service, so you can do your own static conversions with nbconvert, without relying on nbviewer. @@ -80,7 +80,7 @@ without relying on nbviewer. .. seealso:: - :ref:`Details on the notebook JSON file format ` + :ref:`Details on the notebook JSON file format ` Starting the notebook server @@ -267,7 +267,7 @@ Raw cells *Raw* cells provide a place in which you can write *output* directly. Raw cells are not evaluated by the notebook. -When passed through :ref:`nbconvert `, raw cells arrive in the +When passed through nbconvert_, raw cells arrive in the destination format unmodified. For example, this allows you to type full LaTeX into a raw cell, which will only be rendered by LaTeX after conversion by nbconvert. @@ -361,15 +361,13 @@ Plotting One major feature of the Jupyter notebook is the ability to display plots that are the output of running code cells. The IPython kernel is designed to work seamlessly with the matplotlib_ plotting library to provide this functionality. -Specific plotting library integration is a feature of the kernel. See the -:ref:`plotting document ` of the IPython kernel for more -information. +Specific plotting library integration is a feature of the kernel. Installing kernels ------------------ -For information on how to install a Python kernel, refer to :ref:`IPython kernel's -installation document ` +For information on how to install a Python kernel, refer to the `IPython install +page `__. Kernels for other languages can be found in the `IPython wiki `_. diff --git a/docs/source/public_server.rst b/docs/source/public_server.rst index 80c7d8b24a..6873230314 100644 --- a/docs/source/public_server.rst +++ b/docs/source/public_server.rst @@ -4,7 +4,7 @@ Running a notebook server ========================= -The :ref:`Jupyter notebook ` web-application is based on a +The :doc:`Jupyter notebook ` web-application is based on a server-client structure. This server uses a :ref:`two-process kernel architecture ` based on ZeroMQ_, as well as Tornado_ for serving HTTP requests. By default, a notebook server runs on http://127.0.0.1:8888/ @@ -24,11 +24,11 @@ Securing a notebook server You can protect your notebook server with a simple single password by setting the :attr:`NotebookApp.password` configurable. You can prepare a -hashed password using the function :func:`IPython.lib.security.passwd`: +hashed password using the function :func:`notebook.auth.security.passwd`: .. sourcecode:: ipython - In [1]: from IPython.lib import passwd + In [1]: from notebook.auth import passwd In [2]: passwd() Enter password: Verify password: @@ -36,7 +36,7 @@ hashed password using the function :func:`IPython.lib.security.passwd`: .. note:: - :func:`~IPython.lib.security.passwd` can also take the password as a string + :func:`~notebook.auth.security.passwd` can also take the password as a string argument. **Do not** pass it as an argument inside an IPython session, as it will be saved in your input history.