##// END OF EJS Templates
Some rst and configuration fixes.
Matthias Bussonnier -
Show More
@@ -83,9 +83,18 b" templates_path = ['_templates']"
83 83 # The suffix of source filenames.
84 84 source_suffix = '.rst'
85 85
86 if iprelease['_version_extra'] == 'dev':
86 def is_stable(extra):
87 for ext in {'dev', 'b', 'rc'}:
88 if ext in extra:
89 return False
90 return True
91
92 if is_stable(iprelease['_version_extra']):
93 tags.add('ipystable')
94 else:
95 tags.add('ipydev')
87 96 rst_prolog = """
88 .. note::
97 .. warning::
89 98
90 99 This documentation is for a development version of IPython. There may be
91 100 significant differences from the latest stable release.
@@ -99,14 +99,16 b' snippet:'
99 99 ip.sphinxify_docstring = True
100 100 ip.enable_html_pager = True
101 101
102
102 103 You can test the effect of various combinations of the above configuration in
103 104 the Jupyter notebook, with things example like :
104 105
105 .. code-block:: python
106 .. code-block:: ipython
106 107
107 108 import numpy as np
108 109 np.histogram?
109 110
111
110 112 This is part of an effort to make Documentation in Python richer and provide in
111 113 the long term if possible dynamic examples that can contain math, images,
112 114 widgets... As stated above this is nightly experimental feature with a lot of
@@ -117,47 +119,46 b' it.'
117 119 Removed Feature
118 120 ---------------
119 121
120 - ``TerminalInteractiveShell.autoedit_syntax`` Has been broken for many years now
121 apparently. It has been removed.
122 - ``TerminalInteractiveShell.autoedit_syntax`` Has been broken for many years now
123 apparently. It has been removed.
122 124
123 125
124 126 Deprecated Features
125 127 -------------------
126 128
127 Some deprecated feature, don't forget to enable `DeprecationWarning` as error
129 Some deprecated feature, don't forget to enable ``DeprecationWarning`` as error
128 130 of you are using IPython in Continuous Integration setup or in your testing in general:
129 131
130 .. code::
131 :python:
132 .. code-block:: python
132 133
133 134 import warnings
134 135 warnings.filterwarnings('error', '.*', DeprecationWarning, module='yourmodule.*')
135 136
136 137
137 - `hooks.fix_error_editor` seem to be unused and is pending deprecation.
138 - `IPython/core/excolors.py:ExceptionColors` is deprecated.
139 - `IPython.core.InteractiveShell:write()` is deprecated, use `sys.stdout` instead.
140 - `IPython.core.InteractiveShell:write_err()` is deprecated, use `sys.stderr` instead.
141 - The `formatter` keyword argument to `Inspector.info` in `IPython.core.oinspec` has now no effects.
142 - The `global_ns` keyword argument of IPython Embed was deprecated, and will now have no effect. Use `module` keyword argument instead.
138 - ``hooks.fix_error_editor`` seem to be unused and is pending deprecation.
139 - `IPython/core/excolors.py:ExceptionColors` is deprecated.
140 - `IPython.core.InteractiveShell:write()` is deprecated, use `sys.stdout` instead.
141 - `IPython.core.InteractiveShell:write_err()` is deprecated, use `sys.stderr` instead.
142 - The `formatter` keyword argument to `Inspector.info` in `IPython.core.oinspec` has now no effects.
143 - The `global_ns` keyword argument of IPython Embed was deprecated, and will now have no effect. Use `module` keyword argument instead.
143 144
144 145
145 146 Known Issues:
146 147 -------------
147 148
148 - ``<Esc>`` Key does not dismiss the completer and does not clear the current
149 buffer. This is an on purpose modification due to current technical
150 limitation. Cf :ghpull:`9572`. Escape the control character which is used
151 for other shortcut, and there is no practical way to distinguish. Use Ctr-G
152 or Ctrl-C as an alternative.
149 - ``<Esc>`` Key does not dismiss the completer and does not clear the current
150 buffer. This is an on purpose modification due to current technical
151 limitation. Cf :ghpull:`9572`. Escape the control character which is used
152 for other shortcut, and there is no practical way to distinguish. Use Ctr-G
153 or Ctrl-C as an alternative.
153 154
154 - Cannot use ``Shift-Enter`` and ``Ctrl-Enter`` to submit code in terminal. cf
155 :ghissue:`9587` and :ghissue:`9401`. In terminal there is no practical way to
156 distinguish these key sequences from a normal new line return.
155 - Cannot use ``Shift-Enter`` and ``Ctrl-Enter`` to submit code in terminal. cf
156 :ghissue:`9587` and :ghissue:`9401`. In terminal there is no practical way to
157 distinguish these key sequences from a normal new line return.
157 158
158 - ``PageUp`` and ``pageDown`` do not move through completion menu.
159 - ``PageUp`` and ``pageDown`` do not move through completion menu.
159 160
160 - Color styles might not adapt to terminal emulator themes. This will need new
161 version of Pygments to be released, and can be mitigated with custom themes.
161 - Color styles might not adapt to terminal emulator themes. This will need new
162 version of Pygments to be released, and can be mitigated with custom themes.
162 163
163 164
General Comments 0
You need to be logged in to leave comments. Login now