Skip to content

Commit

Permalink
Add changelog entries and API changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ericpre committed May 7, 2023
1 parent c61e2e5 commit 6bca2a4
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 14 deletions.
4 changes: 4 additions & 0 deletions CHANGES.rst
Expand Up @@ -158,6 +158,10 @@ Model fitting
``metadata`` attribute instead.

- The deprecated ``twin_function`` and ``twin_inverse_function`` have been privatized.
- Remove ``fancy`` argument of :meth:`~.model.BaseModel.print_current_values` and :meth:`~.component.Component.print_current_values`,
which wasn't changing the output rendering.



Signal
------
Expand Down
28 changes: 14 additions & 14 deletions doc/conf.py
Expand Up @@ -295,20 +295,20 @@
towncrier_draft_working_directory = ".."

# Add the hyperspy website to the intersphinx domains
intersphinx_mapping = {'rsciio': ('https://hyperspy.org/rosettasciio/', None),
'cupy': ('https://docs.cupy.dev/en/stable', None),
'python': ('https://docs.python.org/3', None),
'h5py': ('https://docs.h5py.org/en/stable', None),
'hyperspyweb': ('https://hyperspy.org/', None),
'matplotlib': ('https://matplotlib.org', None),
'numpy': ('https://docs.scipy.org/doc/numpy', None),
'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
'dask': ('https://docs.dask.org/en/latest', None),
'astroML': ('https://www.astroml.org/', None),
'sklearn': ('https://scikit-learn.org/stable', None),
'skimage': ('https://scikit-image.org/docs/stable', None),
'zarr': ('https://zarr.readthedocs.io/en/stable', None),
}
intersphinx_mapping = {
'cupy': ('https://docs.cupy.dev/en/stable', None),
'dask': ('https://docs.dask.org/en/latest', None),
'h5py': ('https://docs.h5py.org/en/stable', None),
'IPython': ('https://ipython.readthedocs.io/en/stable', None),
'matplotlib': ('https://matplotlib.org', None),
'numpy': ('https://docs.scipy.org/doc/numpy', None),
'python': ('https://docs.python.org/3', None),
'rsciio': ('https://hyperspy.org/rosettasciio/', None),
'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
'skimage': ('https://scikit-image.org/docs/stable', None),
'sklearn': ('https://scikit-learn.org/stable', None),
'zarr': ('https://zarr.readthedocs.io/en/stable', None),
}

# -- Sphinx-Gallery---------------

Expand Down
2 changes: 2 additions & 0 deletions upcoming_changes/3145.api.rst
@@ -0,0 +1,2 @@
Fix behaviour of :meth:`~.model.BaseModel.print_current_values`, :meth:`~.component.Component.print_current_values`
and :func:`~.api.print_known_signal_types`, which were not printing when running from a script - they were only printing when running in notebook or qtconsole. Now all print_* functions behave consistently: they all print the output instead of returning an object (string or html). The :func:`IPython.display.display` will pick a suitable rendering when running in an "ipython" context, for example notebook, qtconsole.
1 change: 1 addition & 0 deletions upcoming_changes/3145.maintenance.rst
@@ -0,0 +1 @@
IPython and IParallel are now optional dependencies

0 comments on commit 6bca2a4

Please sign in to comment.