Question

假设my_module具有以下__init__.py：

from my_module.misc import f2

def f1(p1,p2):
    """
    My f1 function.

    :param p1: First parameter.
    :param p2: Second parameter.
    :return: Returned value.
    """
    return p1 + p2

misc.py包含以下功能：

def f2(p1,p2):
    """
    My f2 function.

    :param p1: First parameter.
    :param p2: Second parameter.
    :return: Returned value.
    """
    return p1 - p2

我使用以下方法使用sphinx记录my_module并且f2没有出现在结果中，是否有指定应该包含它的方法？

my_module
---------

.. automodule:: my_module
   :members:
   :undoc-members:

Answer 1

如果在__init __。py。

中添加

public class ResourceAttribute
{
   string AttributeName;
   string DataType;
   object StringValue;
   object DefaultStringValue;
}

列表，则此方法有效

__all__

来自Sphinx documentation：

对于模块，除非您提供from my_module.misc import f2 __all__ = ["f1", "f2"] def f1(p1,p2): """ My f1 function. :param p1: First parameter. :param p2: Second parameter. :return: Returned value. """ return p1 + p2标记选项，否则在查找成员时将会尊重__all__。如果没有ignore-module-all，成员的顺序也将是ignore-module-all中的顺序。

在sphinx文档中包含特定的导入函数

1 个答案: