From 46995271c20ee698f836458eb7a225639cfa2f9f 2016-06-25 00:10:06 From: Matthias Bussonnier Date: 2016-06-25 00:10:06 Subject: [PATCH] Some rst and configuration fixes. --- diff --git a/docs/source/conf.py b/docs/source/conf.py index 91be39f..262ef2e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -83,9 +83,18 @@ templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' -if iprelease['_version_extra'] == 'dev': +def is_stable(extra): + for ext in {'dev', 'b', 'rc'}: + if ext in extra: + return False + return True + +if is_stable(iprelease['_version_extra']): + tags.add('ipystable') +else: + tags.add('ipydev') rst_prolog = """ - .. note:: + .. warning:: This documentation is for a development version of IPython. There may be significant differences from the latest stable release. diff --git a/docs/source/whatsnew/version5.rst b/docs/source/whatsnew/version5.rst index 808a085..fc2d1aa 100644 --- a/docs/source/whatsnew/version5.rst +++ b/docs/source/whatsnew/version5.rst @@ -99,14 +99,16 @@ snippet: ip.sphinxify_docstring = True ip.enable_html_pager = True + You can test the effect of various combinations of the above configuration in the Jupyter notebook, with things example like : -.. code-block:: python +.. code-block:: ipython import numpy as np np.histogram? + This is part of an effort to make Documentation in Python richer and provide in the long term if possible dynamic examples that can contain math, images, widgets... As stated above this is nightly experimental feature with a lot of @@ -117,47 +119,46 @@ it. Removed Feature --------------- - - ``TerminalInteractiveShell.autoedit_syntax`` Has been broken for many years now -apparently. It has been removed. +- ``TerminalInteractiveShell.autoedit_syntax`` Has been broken for many years now + apparently. It has been removed. Deprecated Features ------------------- -Some deprecated feature, don't forget to enable `DeprecationWarning` as error +Some deprecated feature, don't forget to enable ``DeprecationWarning`` as error of you are using IPython in Continuous Integration setup or in your testing in general: -.. code:: - :python: +.. code-block:: python import warnings warnings.filterwarnings('error', '.*', DeprecationWarning, module='yourmodule.*') - - `hooks.fix_error_editor` seem to be unused and is pending deprecation. - - `IPython/core/excolors.py:ExceptionColors` is deprecated. - - `IPython.core.InteractiveShell:write()` is deprecated, use `sys.stdout` instead. - - `IPython.core.InteractiveShell:write_err()` is deprecated, use `sys.stderr` instead. - - The `formatter` keyword argument to `Inspector.info` in `IPython.core.oinspec` has now no effects. - - The `global_ns` keyword argument of IPython Embed was deprecated, and will now have no effect. Use `module` keyword argument instead. +- ``hooks.fix_error_editor`` seem to be unused and is pending deprecation. +- `IPython/core/excolors.py:ExceptionColors` is deprecated. +- `IPython.core.InteractiveShell:write()` is deprecated, use `sys.stdout` instead. +- `IPython.core.InteractiveShell:write_err()` is deprecated, use `sys.stderr` instead. +- The `formatter` keyword argument to `Inspector.info` in `IPython.core.oinspec` has now no effects. +- The `global_ns` keyword argument of IPython Embed was deprecated, and will now have no effect. Use `module` keyword argument instead. Known Issues: ------------- - - ```` Key does not dismiss the completer and does not clear the current - buffer. This is an on purpose modification due to current technical - limitation. Cf :ghpull:`9572`. Escape the control character which is used - for other shortcut, and there is no practical way to distinguish. Use Ctr-G - or Ctrl-C as an alternative. +- ```` Key does not dismiss the completer and does not clear the current + buffer. This is an on purpose modification due to current technical + limitation. Cf :ghpull:`9572`. Escape the control character which is used + for other shortcut, and there is no practical way to distinguish. Use Ctr-G + or Ctrl-C as an alternative. - - Cannot use ``Shift-Enter`` and ``Ctrl-Enter`` to submit code in terminal. cf - :ghissue:`9587` and :ghissue:`9401`. In terminal there is no practical way to - distinguish these key sequences from a normal new line return. +- Cannot use ``Shift-Enter`` and ``Ctrl-Enter`` to submit code in terminal. cf + :ghissue:`9587` and :ghissue:`9401`. In terminal there is no practical way to + distinguish these key sequences from a normal new line return. - - ``PageUp`` and ``pageDown`` do not move through completion menu. +- ``PageUp`` and ``pageDown`` do not move through completion menu. - - Color styles might not adapt to terminal emulator themes. This will need new - version of Pygments to be released, and can be mitigated with custom themes. +- Color styles might not adapt to terminal emulator themes. This will need new + version of Pygments to be released, and can be mitigated with custom themes.