fix links and lint

hyperspy · Mar 12, 2024 · 3985e03 · 3985e03
1 parent eaf1f30
commit 3985e03
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 13 deletions.
diff --git 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
@@ -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
@@ -6,7 +6,7 @@ HoloSpy metadata structure
 HoloSpy extends the :external+hyperspy:ref:`HyperSpy metadata structure
 <metadata_structure>`
 with conventions for metadata specific to its signal types. Refer to the
-:external+hyperspy:doc:`HyperSpy metadata documentation <user_guide/metadata_structure>`
+:external+hyperspy:ref:`HyperSpy metadata documentation <metadata_structure>`
 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
-<https://hyperspy.org/hyperspy-doc/current/user_guide/metadata_structure.html#general>`_.
+See :external+hyperspy:ref:`HyperSpy-Metadata-General
+<general-metadata>`.
 
 Sample
 ======
 
-See `HyperSpy-Metadata-Sample
-<https://hyperspy.org/hyperspy-doc/current/user_guide/metadata_structure.html#sample>`_.
+See :external+hyperspy:ref:`HyperSpy-Metadata-Sample
+<sample-metadata>`.
 
 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
-<https://hyperspy.org/hyperspy-doc/current/user_guide/metadata_structure.html#signal>`__
-for additional fields.
+See :external+hyperspy:ref:`HyperSpy-Metadata-Signal <signal-metadata>` for
+additional fields.
 
 Acquisition Instrument
 ======================
@@ -98,5 +97,4 @@ voltage
 
     Voltage of electrostatic biprism in volts
 
-See `HyperSpy-Metadata-TEM <https://hyperspy.org/hyperspy-doc/current/user_guide/metadata_structure.html#tem>`_
-	for additional fields.
+See :external+exspy:ref:`eXSpy TEM metadata <source-metadata>` for additional fields.
diff --git 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.