狮身人面像:"警告:重复的对象描述"的原因是什么?



我收到多个警告,如:

警告:pyfar.signal.TimeData.times的对象描述重复,pyfar.classes_audio中的其他实例,请使用:noindex:作为其中一个

却搞不明白为什么?有人建议我可能在不同的rst文件中包含两次相同的对象。但我认为情况并非如此。

我试图在原始包的基础上创建一个最小的工作示例(https://github.com/pyfar/pyfar/tree/develop/docs):

获取代码

git clone https://github.com/f-brinkmann/pyfar_sphinx_test.git pyfar_sphinx_test
cd pyfar_sphinx_test

制作一个虚拟环境

conda create --name sphinx_test python<3.9
conda activate sphinx_test
pip install -r requirements_dev.txt
pip install -e .

建立文档

cd docs
make clean
make html

产生

Running Sphinx v3.5.3
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] index
C:UserspanikDesktoppyfar_sphinx_testpyfarsignal.py:docstring of pyfar.signal.FrequencyData.fft_norm:1: WARNING: duplicate object description of pyfar.signal.FrequencyData.fft_norm, other instance in index, use :noindex: for one of them
C:UserspanikDesktoppyfar_sphinx_testpyfarsignal.py:docstring of pyfar.signal.FrequencyData.frequencies:1: WARNING: duplicate object description of pyfar.signal.FrequencyData.frequencies, other instance in index, use :noindex: for one of them
C:UserspanikDesktoppyfar_sphinx_testpyfarsignal.py:docstring of pyfar.signal.Signal.domain:1: WARNING: duplicate object description of pyfar.signal.Signal.domain, other instance in index, use :noindex: for one of them
C:UserspanikDesktoppyfar_sphinx_testpyfarsignal.py:docstring of pyfar.signal.Signal.fft_norm:1: WARNING: duplicate object description of pyfar.signal.Signal.fft_norm, other instance in index, use :noindex: for one of them
C:UserspanikDesktoppyfar_sphinx_testpyfarsignal.py:docstring of pyfar.signal.Signal.sampling_rate:1: WARNING: duplicate object description of pyfar.signal.Signal.sampling_rate, other instance in index, use :noindex: for one of them
C:UserspanikDesktoppyfar_sphinx_testpyfarsignal.py:docstring of pyfar.signal.TimeData.times:1: WARNING: duplicate object description of pyfar.signal.TimeData.times, other instance in index, use :noindex: for one of them
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
generating indices... genindex py-modindex done
highlighting module code... [100%] pyfar.signal
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 6 warnings.

感谢您的回复,Fabian

问题似乎是您在某些__init__方法中使用了文档字符串中的Attributes标头。如果更改为Parameters(这是正确的标头(,则警告将消失。

示例:

def __init__(self, data, frequencies, fft_norm=None, comment=None,
dtype=complex):
"""Init FrequencyData with data, and frequencies.

Parameters
----------
data : array, double
Raw data in the frequency domain. The memory layout of Data is 'C'.
E.g. data of shape (3, 2, 1024) has 3 x 2 channels with 1024
frequency bins each.
frequencies : array, double
Frequencies of the data in Hz. The number of frequencies must match
the size of the last dimension of data.
fft_norm : 'none', 'unitary', 'amplitude', 'rms', 'power', 'psd'
The kind of Discrete Fourier Transform (DFT) normalization. See
pyfar.fft.normalization and _[#] for more information. The default
is 'none', which is typically used for energy signals, such as
impulse responses.
comment : str
A comment related to the data. The default is None.
dtype : string, optional
Raw data type of the signal. The default is float64

最新更新