From e4d45107e58585bb16de4900caa2992ecc636e10 Mon Sep 17 00:00:00 2001 From: Takeshi Ikuma Date: Sun, 28 Feb 2021 14:03:34 -0600 Subject: [PATCH] Fixed sphinx link :object: to :obj: --- src/parselmouth/LPC_docstrings.h | 18 +++++++++--------- .../LineSpectralFrequencies_docstrings.h | 4 ++-- src/parselmouth/Sound_docstrings.h | 16 ++++++++-------- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/src/parselmouth/LPC_docstrings.h b/src/parselmouth/LPC_docstrings.h index 316c0850..3802c933 100644 --- a/src/parselmouth/LPC_docstrings.h +++ b/src/parselmouth/LPC_docstrings.h @@ -11,13 +11,13 @@ a frame of acoustic data samples. Note that the $a_0=1$ coefficient is omitted in a. -This class is instantiated in :object:`~parselmouth.LPC` object and not +This class is instantiated in :obj:`~parselmouth.LPC` object and not intended to be instantiated by user. See also -------- :praat:`Sound: LPC analysis` -:object:`~parselmouth.LPC` +:obj:`~parselmouth.LPC` )"; constexpr auto FRAME_N_COEFFICIENTS = R"(int : Number of AR coefficients a used to model the frame)"; @@ -40,13 +40,13 @@ samples, x′n = ∑ ak xn-k then {a1, a2, ..., ap} can be chosen to minimize the prediction power Qp where Qp = E[ |xn - x′n|2 ]. This class is not intended to be instantiated by user, instead from a -:object:`~parselmouth.Sound` object using one of its to_lpc_xxx() +:obj:`~parselmouth.Sound` object using one of its to_lpc_xxx() methods. See Also -------- :praat:`Sound: LPC analysis` -:object:`parselmouth.LPC.Frame` +:obj:`parselmouth.LPC.Frame` :func:`parselmouth.Sound.to_lpc_autocorrelation` :func:`parselmouth.Sound.to_lpc_covariance` :func:`parselmouth.Sound.to_lpc_burg` @@ -58,7 +58,7 @@ constexpr auto MAX_N_COEFFICIENTS_DOCSTRING = R"(Largest number of coefficients constexpr auto TO_LINE_SPECTRAL_FREQUENCIES=R"(Convert to line spectra. -Returns :object:`parselmouth.LineSpectralFrequencies` object with the +Returns :obj:`parselmouth.LineSpectralFrequencies` object with the line frequencies found in the LPC models. Parameter @@ -68,17 +68,17 @@ grid_size : float, default=0.0 See also -------- -:object:`parselmouth.LineSpectralFrequencies` +:obj:`parselmouth.LineSpectralFrequencies` )"; constexpr auto TO_SPECTRUM_SLICE_DOCSTRING=R"(Convert to spectrogram. -Returns :object:`parselmouth.Spectrum` object with the spectral +Returns :obj:`parselmouth.Spectrum` object with the spectral representation of the LPC model found at specified time t. The Spectrum at t will be calculated from the nearest -:object:`~parselmouth.LPC.Frame`. See :praat:`LPC: To Spectrum (slice)...` +:obj:`~parselmouth.LPC.Frame`. See :praat:`LPC: To Spectrum (slice)...` for dedailed algorithm description. Parameters @@ -111,7 +111,7 @@ See also constexpr auto TO_SPECTROGRAM_DOCSTRING=R"(Convert to spectrogram. -Returns :object:`parselmouth.Spectrogram` object with the spectral +Returns :obj:`parselmouth.Spectrogram` object with the spectral representation of the LPC models. For each LPC_Frame the corresponding Spectrum will be calculated according diff --git a/src/parselmouth/LineSpectralFrequencies_docstrings.h b/src/parselmouth/LineSpectralFrequencies_docstrings.h index 12aa5429..46cd0820 100644 --- a/src/parselmouth/LineSpectralFrequencies_docstrings.h +++ b/src/parselmouth/LineSpectralFrequencies_docstrings.h @@ -28,11 +28,11 @@ constexpr auto MAXIMUM_NUMBER_OF_FREQUENCIES_DOCSTRING = R"(int, readonly : Larg constexpr auto TO_LPC_DOCSTRING=R"(Convert to LPC object. -Returns :object:`parselmouth.LPC` object with equivalent AR models. +Returns :obj:`parselmouth.LPC` object with equivalent AR models. See also -------- -:object:`parselmouth.LPC` +:obj:`parselmouth.LPC` :func:`parselmouth.LPC.to_line_spectral_frequencies` )"; diff --git a/src/parselmouth/Sound_docstrings.h b/src/parselmouth/Sound_docstrings.h index 021ae07a..4654b027 100644 --- a/src/parselmouth/Sound_docstrings.h +++ b/src/parselmouth/Sound_docstrings.h @@ -5,7 +5,7 @@ namespace parselmouth { constexpr auto TO_LPC_AUTOCORRELATION_DOCSTRING = R"(Create LPC using autocorrelation method. Run linear predictive coding (LPC) analysis with the autocorrelation -method and returns a new :object:`~parselmouth.LPC` object containing the +method and returns a new :obj:`~parselmouth.LPC` object containing the analysis outcomes. The autocorrelation algorithm is decribed in Markel & Gray (1976). @@ -37,7 +37,7 @@ preemphasis_frequency : float, default=50.0 See Also -------- :praat:`Sound: To LPC (autocorrelation)...` -:object:`~parselmouth.LPC` +:obj:`~parselmouth.LPC` :func:`~parselmouth.Sound.to_lpc_covariance` :func:`~parselmouth.Sound.to_lpc_burg` :func:`~parselmouth.Sound.to_lpc_marple` @@ -46,7 +46,7 @@ See Also constexpr auto TO_LPC_COVARIANCE_DOCSTRING = R"(Create LPC using covariance method. Run linear predictive coding (LPC) analysis with the covariance method and -returns a new :object:`~parselmouth.LPC` object containing the analysis +returns a new :obj:`~parselmouth.LPC` object containing the analysis outcomes. The covariance algorithm is decribed in Markel & Gray (1976). @@ -78,7 +78,7 @@ preemphasis_frequency : float, default=50.0 See Also -------- :praat:`Sound: To LPC (covariance)...` -:object:`~parselmouth.LPC` +:obj:`~parselmouth.LPC` :func:`~parselmouth.Sound.to_lpc_autocorrelation` :func:`~parselmouth.Sound.to_lpc_burg` :func:`~parselmouth.Sound.to_lpc_marple` @@ -87,7 +87,7 @@ See Also constexpr auto TO_LPC_BURG_DOCSTRING = R"(Create LPC using Burg's method. Run linear predictive coding (LPC) analysis with the Burg's method and -returns a new :object:`~parselmouth.LPC` object containing the analysis +returns a new :obj:`~parselmouth.LPC` object containing the analysis outcomes. Burg's algorithm is described in Anderson (1978) @@ -119,7 +119,7 @@ preemphasis_frequency : float, default=50.0 See Also -------- :praat:`Sound: To LPC (burg)...` -:object:`~parselmouth.LPC` +:obj:`~parselmouth.LPC` :func:`~parselmouth.Sound.to_lpc_autocorrelation` :func:`~parselmouth.Sound.to_lpc_covariance` :func:`~parselmouth.Sound.to_lpc_marple` @@ -128,7 +128,7 @@ See Also constexpr auto TO_LPC_MARPLE_DOCSTRING = R"(Create LPC using Marple's method. Run linear predictive coding (LPC) analysis with the Marple's method and -returns a new :object:`~parselmouth.LPC` object containing the analysis +returns a new :obj:`~parselmouth.LPC` object containing the analysis outcomes. The algorithm is described in Marple (1980). @@ -167,7 +167,7 @@ tolerance 2 : float, default=1e-6 See Also -------- :praat:`Sound: To LPC (marple)...` -:object:`~parselmouth.LPC` +:obj:`~parselmouth.LPC` :func:`~parselmouth.Sound.to_lpc_autocorrelation` :func:`~parselmouth.Sound.to_lpc_covariance` :func:`~parselmouth.Sound.to_lpc_burg`