From 429d1afa412126588c64339df3486c308cc9b238 Mon Sep 17 00:00:00 2001 From: jlaehne Date: Wed, 13 Mar 2024 00:40:34 +0100 Subject: [PATCH] fix links and lint --- doc/conf.py | 1 + doc/user_guide/electron_holography.rst | 2 +- doc/user_guide/metadata_structure.rst | 17 ++++++++--------- holospy/signals/hologram_image.py | 2 -- 4 files changed, 10 insertions(+), 12 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index ba76401..d69b3e0 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -53,6 +53,7 @@ intersphinx_mapping = { "dask": ("https://docs.dask.org/en/latest", None), + "exspy": ("https://hyperspy.org/exspy", None), "hyperspy": ("https://hyperspy.org/hyperspy-doc/current/", None), "kikuchipy": ("https://kikuchipy.org/en/latest/", None), "matplotlib": ("https://matplotlib.org/stable", None), diff --git a/doc/user_guide/electron_holography.rst b/doc/user_guide/electron_holography.rst index d5b8909..279ca37 100644 --- a/doc/user_guide/electron_holography.rst +++ b/doc/user_guide/electron_holography.rst @@ -79,7 +79,7 @@ hologram should be provided to the method either as Hyperspy's Using the reconstructed wave, one can access its amplitude and phase (also unwrapped phase) using ``amplitude`` and ``phase`` properties -(also the :external+hyperspy:py:meth:`hyperspy._signals.complex_signal.ComplexSignal.unwrapped_phase` +(also the :external+hyperspy:meth:`hyperspy.api.signals.ComplexSignal.unwrapped_phase` method): .. code-block:: python diff --git a/doc/user_guide/metadata_structure.rst b/doc/user_guide/metadata_structure.rst index 16cac04..fa79ee3 100644 --- a/doc/user_guide/metadata_structure.rst +++ b/doc/user_guide/metadata_structure.rst @@ -6,7 +6,7 @@ HoloSpy metadata structure HoloSpy extends the :external+hyperspy:ref:`HyperSpy metadata structure ` with conventions for metadata specific to its signal types. Refer to the -:external+hyperspy:doc:`HyperSpy metadata documentation ` +:external+hyperspy:ref:`HyperSpy metadata documentation ` for general metadata fields. The metadata of any **signal objects** is stored in the `metadata` attribute, @@ -49,14 +49,14 @@ all types of leaves will apply to every type of measurement. General ======= -See `HyperSpy-Metadata-General -`_. +See :external+hyperspy:ref:`HyperSpy-Metadata-General +`. Sample ====== -See `HyperSpy-Metadata-Sample -`_. +See :external+hyperspy:ref:`HyperSpy-Metadata-Sample +`. Signal ====== @@ -67,9 +67,8 @@ signal_type String that describes the type of signal. Currently, the only HoloSpy specific signal class is ``hologram``. -See `HyperSpy-Metadata-Signal -`__ -for additional fields. +See :external+hyperspy:ref:`HyperSpy-Metadata-Signal `for +additional fields. Acquisition Instrument ====================== @@ -98,5 +97,5 @@ voltage Voltage of electrostatic biprism in volts -See `HyperSpy-Metadata-TEM `_ +See :external+exspy:ref:`eXSpy TEM metadata ` for additional fields. diff --git a/holospy/signals/hologram_image.py b/holospy/signals/hologram_image.py index 6a8ccb3..d35db5a 100644 --- a/holospy/signals/hologram_image.py +++ b/holospy/signals/hologram_image.py @@ -150,7 +150,6 @@ def _estimate_fringe_contrast_statistical(holo): class HologramImage(Signal2D): - """Signal class for holograms acquired via off-axis electron holography.""" _signal_type = "hologram" @@ -937,7 +936,6 @@ def statistics( class LazyHologramImage(LazySignal, HologramImage): - """ Lazy signal class for holograms acquired via off-axis electron holography.