diff --git a/docs/source/conf.py b/docs/source/conf.py index b32efe6..7b4ebfb 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -128,6 +128,8 @@ exclude_patterns = ['whatsnew/pr'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' +# Set the default role so we can use `foo` instead of ``foo`` +default_role = 'literal' # Options for HTML output # ----------------------- diff --git a/docs/source/whatsnew/development.rst b/docs/source/whatsnew/development.rst index 9b11124..320a758 100644 --- a/docs/source/whatsnew/development.rst +++ b/docs/source/whatsnew/development.rst @@ -11,12 +11,82 @@ This document describes in-flight development work. `docs/source/whatsnew/pr` folder +* :class:`~.TextWidget` and :class:`~.TextareaWidget` objects now include a + ``placeholder`` attribute, for displaying placeholder text before the + user has typed anything. + +* The %load magic can now find the source for objects in the user namespace. + To enable searching the namespace, use the ``-n`` option. + + .. sourcecode:: ipython + + In [1]: %load -n my_module.some_function + +* :class:`~.DirectView` objects have a new :meth:`~.DirectView.use_cloudpickle` + method, which works like ``view.use_dill()``, but causes the ``cloudpickle`` + module from PiCloud's `cloud`__ library to be used rather than dill or the + builtin pickle module. + + __ https://pypi.python.org/pypi/cloud + +* Added a .ipynb exporter to nbconvert. It can be used by passing `--to notebook` + as a commandline argument to nbconvert. + +* New nbconvert preprocessor called :class:`~.ClearOutputPreprocessor`. This + clears the output from IPython notebooks. + +* New preprocessor for nbconvert that executes all the code cells in a notebook. + To run a notebook and save its output in a new notebook:: + + ipython nbconvert InputNotebook --ExecutePreprocessor.enabled=True --to notebook --output Executed + .. DO NOT EDIT THIS LINE BEFORE RELEASE. FEATURE INSERTION POINT. Backwards incompatible changes ------------------------------ +* :func:`IPython.core.oinspect.getsource` call specification has changed: + + * `oname` keyword argument has been added for property source formatting + * `is_binary` keyword argument has been dropped, passing ``True`` had + previously short-circuited the function to return ``None`` unconditionally + +* Removed the octavemagic extension: it is now available as ``oct2py.ipython``. + +* Creating PDFs with LaTeX no longer uses a post processor. + Use `nbconvert --to pdf` instead of `nbconvert --to latex --post pdf`. + +* Used https://github.com/jdfreder/bootstrap2to3 to migrate the Notebook to Bootstrap 3. + + Additional changes: + + - Set `.tab-content .row` `0px;` left and right margin (bootstrap default is `-15px;`) + - Removed `height: @btn_mini_height;` from `.list_header>div, .list_item>div` in `tree.less` + - Set `#header` div `margin-bottom: 0px;` + - Set `#menus` to `float: left;` + - Set `#maintoolbar .navbar-text` to `float: none;` + - Added no-padding convienence class. + - Set border of #maintoolbar to 0px + +* Accessing the `container` DOM object when displaying javascript has been + deprecated in IPython 2.0 in favor of accessing `element`. Starting with + IPython 3.0 trying to access `container` will raise an error in browser + javascript console. + +IFrame embedding +```````````````` + +The IPython Notebook and its APIs by default will only be allowed to be +embedded in an iframe on the same origin. + +To override this, set ``headers[X-Frame-Options]`` to one of + +* DENY +* SAMEORIGIN +* ALLOW-FROM uri + +See `Mozilla's guide to X-Frame-Options `_ for more examples. + .. DO NOT EDIT THIS LINE BEFORE RELEASE. INCOMPAT INSERTION POINT. - \ No newline at end of file diff --git a/docs/source/whatsnew/pr/clear-output-preprocessor.rst b/docs/source/whatsnew/pr/clear-output-preprocessor.rst deleted file mode 100644 index 5004798..0000000 --- a/docs/source/whatsnew/pr/clear-output-preprocessor.rst +++ /dev/null @@ -1 +0,0 @@ -Adds an optional preprocessor step to `nbconvert` called `ClearOutputPreprocessor`. This clears the output from IPython notebooks. diff --git a/docs/source/whatsnew/pr/cloudpickle.rst b/docs/source/whatsnew/pr/cloudpickle.rst deleted file mode 100644 index a0af161..0000000 --- a/docs/source/whatsnew/pr/cloudpickle.rst +++ /dev/null @@ -1,5 +0,0 @@ -* Adds a ``use_cloudpickle`` method to ``DirectView`` objects, which works like - ``view.use_dill()``, but causes the ``cloudpickle`` module from PiCloud's - `cloud`__ library to be used rather than dill or the builtin pickle module. - - __ https://pypi.python.org/pypi/cloud diff --git a/docs/source/whatsnew/pr/execute-preprocessor b/docs/source/whatsnew/pr/execute-preprocessor deleted file mode 100644 index fd3eacf..0000000 --- a/docs/source/whatsnew/pr/execute-preprocessor +++ /dev/null @@ -1,4 +0,0 @@ -New preprocessor for nbconvert that executes all the code cells in a notebook. -To run a notebook and save its output in a new notebook:: - - ipython nbconvert InputNotebook --ExecutePreprocessor.enabled=True --to notebook --output Executed diff --git a/docs/source/whatsnew/pr/incompat-migrate-to-bootsrap3.rst b/docs/source/whatsnew/pr/incompat-migrate-to-bootsrap3.rst deleted file mode 100644 index 5bc786f..0000000 --- a/docs/source/whatsnew/pr/incompat-migrate-to-bootsrap3.rst +++ /dev/null @@ -1,11 +0,0 @@ -Used https://github.com/jdfreder/bootstrap2to3 to migrate the Notebook to Bootstrap 3. - -Additional changes: -- Set `.tab-content .row` `0px;` left and right margin (bootstrap default is `-15px;`) -- Removed `height: @btn_mini_height;` from `.list_header>div, .list_item>div` in `tree.less` -- Set `#header` div `margin-bottom: 0px;` -- Set `#menus` to `float: left;` -- Set `#maintoolbar .navbar-text` to `float: none;` - -- Added no-padding convienence class. -- Set border of #maintoolbar to 0px \ No newline at end of file diff --git a/docs/source/whatsnew/pr/incompat-oinspect-getsource.rst b/docs/source/whatsnew/pr/incompat-oinspect-getsource.rst deleted file mode 100644 index 453377b..0000000 --- a/docs/source/whatsnew/pr/incompat-oinspect-getsource.rst +++ /dev/null @@ -1,5 +0,0 @@ -* :func:`IPython.core.oinspect.getsource` call specification has changed: - - * `oname` keyword argument has been added for property source formatting - * `is_binary` keyword argument has been dropped, passing ``True`` had - previously short-circuited the function to return ``None`` unconditionally diff --git a/docs/source/whatsnew/pr/incompat-only-same-origin-iframe-embedding.rst b/docs/source/whatsnew/pr/incompat-only-same-origin-iframe-embedding.rst deleted file mode 100644 index 7fc48a6..0000000 --- a/docs/source/whatsnew/pr/incompat-only-same-origin-iframe-embedding.rst +++ /dev/null @@ -1,11 +0,0 @@ -The IPython Notebook and its APIs by default will only be allowed to be -embedded in an iframe on the same origin. - -To override this, set ``headers[X-Frame-Options]`` to one of - -* DENY -* SAMEORIGIN -* ALLOW-FROM uri - -See `Mozilla's guide to X-Frame-Options`_ for more examples. - diff --git a/docs/source/whatsnew/pr/incompat-remove-js-container.rst b/docs/source/whatsnew/pr/incompat-remove-js-container.rst deleted file mode 100644 index 9f1d943..0000000 --- a/docs/source/whatsnew/pr/incompat-remove-js-container.rst +++ /dev/null @@ -1,4 +0,0 @@ -Accessing the `container` DOM object when displaying javascript has been -deprecated in IPython 2.0 in favor of accessing `element`. Starting with -IPython 3.0 trying to access `container` will raise an error in browser -javascript console. diff --git a/docs/source/whatsnew/pr/incompat-rm-octavemagic.rst b/docs/source/whatsnew/pr/incompat-rm-octavemagic.rst deleted file mode 100644 index 4331fba..0000000 --- a/docs/source/whatsnew/pr/incompat-rm-octavemagic.rst +++ /dev/null @@ -1 +0,0 @@ -* Removed the octavemagic extension: it is now available as ``oct2py.ipython``. diff --git a/docs/source/whatsnew/pr/incompat-rm-pdf-post.rst b/docs/source/whatsnew/pr/incompat-rm-pdf-post.rst deleted file mode 100644 index 54145db..0000000 --- a/docs/source/whatsnew/pr/incompat-rm-pdf-post.rst +++ /dev/null @@ -1,2 +0,0 @@ -Creating PDFs with LaTeX no longer uses a post processor. -Use `nbconvert --to pdf` instead of `nbconvert --to latex --post pdf`. diff --git a/docs/source/whatsnew/pr/load_from_namespace.rst b/docs/source/whatsnew/pr/load_from_namespace.rst deleted file mode 100644 index 25d33b7..0000000 --- a/docs/source/whatsnew/pr/load_from_namespace.rst +++ /dev/null @@ -1,6 +0,0 @@ -Adds object inspection to %load magic so that source for objects in user or global namespaces can be loaded. To enable searching the namespace, use the ``-n`` option. - -.. sourcecode:: ipython - - In [1]: %load -n my_module.some_function - diff --git a/docs/source/whatsnew/pr/notebook-exporter.rst b/docs/source/whatsnew/pr/notebook-exporter.rst deleted file mode 100644 index b5e4947..0000000 --- a/docs/source/whatsnew/pr/notebook-exporter.rst +++ /dev/null @@ -1,2 +0,0 @@ -Added a .ipynb exporter to nbconvert. It can be used by passing `--to notebook` -as a commandline argument to nbconvert. diff --git a/docs/source/whatsnew/pr/textwidget-placeholder.rst b/docs/source/whatsnew/pr/textwidget-placeholder.rst deleted file mode 100644 index 0d20265..0000000 --- a/docs/source/whatsnew/pr/textwidget-placeholder.rst +++ /dev/null @@ -1,3 +0,0 @@ -* `TextWidget` and `TextareaWidget` objects now include a - `placeholder` attribute, for displaying placeholder text before the - user has typed anything.