sphinx 警告：自动摘要：找不到该类的方法的存根文件。检查您的 autosummary_generate 设置

Question

我有一个开源包，在不同的子模块上有很多类。所有类都有方法fit和transform，并继承fit_transform自 sklearn。所有的类都遵循与副标题参数，属性，注释numpydoc，请参见，和方法的文档字符串，在这里我表fit，transform和fit_transform。我复制一个类的例子：

class DropFeatures(BaseEstimator, TransformerMixin):
    """
    Some description.

    Parameters
    ----------
    features_to_drop : str or list, default=None
        Variable(s) to be dropped from the dataframe

    Methods
    -------
    fit
    transform
    fit_transform
    """

    def __init__(self, features_to_drop: List[Union[str, int]]):

        some init parameters

    def fit(self, X: pd.DataFrame, y: pd.Series = None):
        """
        This transformer does not learn any parameter.

        Verifies that the input X is a pandas dataframe, and that the variables to
        drop exist in the training dataframe.

        Parameters
        ----------
        X : pandas dataframe of shape = [n_samples, n_features]
            The input dataframe
        y : pandas Series, default = None
            y is not needed for this transformer. You can pass y or None.

        Returns
        -------
        self
        """
        some functionality

        return self

    def transform(self, X: pd.DataFrame):
        """
        Drop the variable or list of variables from the dataframe.

        Parameters
        ----------
        X : pandas dataframe
            The input dataframe from which features will be dropped

        Returns
        -------
        X_transformed : pandas dataframe,
            shape = [n_samples, n_features - len(features_to_drop)]
            The transformed dataframe with the remaining subset of variables.

        """

        some more functionality

        return X

在 Sphinx 的 conf.py 中，我包括：

extensions = [
    "sphinx.ext.autodoc",  # Core Sphinx library for auto html doc generation from docstrings
    "sphinx.ext.autosummary",  # Create neat summary tables for modules/classes/methods etc
    "sphinx.ext.intersphinx",  # Link to other project's documentation (see mapping below)
    "sphinx_autodoc_typehints",  # Automatically document param types (less noise in class signature)
    "numpydoc",
    "sphinx.ext.linkcode",
] 


numpydoc_show_class_members = False


# generate autosummary even if no references
autosummary_generate = True
autosummary_imported_members = True

当我使用 构建文档时 sphinx-build -b html docs build，文档构建得非常好，但每个类都会收到 3 个警告，每个方法一个，即：

warning: autosummary: stub file not found for the methods of the class. check your autosummary_generate settings

我已经用尽了我所有的搜索资源，我准备放弃了。有人知道如何防止该警告或如何使 sphinx 不将其打印到控制台吗？

我附上了错误的副本，如果需要，我可以提供指向回购的 PR 的链接

Answer 1

setup.py就我而言，文件夹中的以下添加doc删除了警告：

numpydoc_show_class_members = False 

添加方法将方法限制在固定列表中，这不是我想要的行为。

Answer 2

好吧，3天后，我钉了它。秘诀是在标题“方法”之后为文档字符串中的方法添加简短描述，而不是像我一样将它们留空。

所以：

class DropFeatures(BaseEstimator, TransformerMixin):

        Some description.
    
        Parameters
        ----------
        features_to_drop : str or list, default=None
            Variable(s) to be dropped from the dataframe
    
        Methods
        -------
        fit:
           some description
        transform:
          some description
        fit_transform:
          some description