Python 在Sphinx文档中,是否可以使用模块名指定要包含的代码示例?

Python 在Sphinx文档中,是否可以使用模块名指定要包含的代码示例?,python,python-sphinx,Python,Python Sphinx,我想在sphinx文档中包含一个代码示例。 但是,我不想通过路径引用文件, 而是通过它的模块名来指定它 也就是说,不要按照这里所指的方式来做 或 我宁愿这样做(例如) 这是否可以在不编写自定义扩展的情况下实现? 或者,编写这样一个扩展的最简单方法是什么?您可以使用以下内容引用其他类: :class:`~module.submodule.Class` 如果您将示例作为doctest添加到类中,那么您就有了一些示例,这些示例可以保证正常工作,因为它们是可直接运行的。您可以使用以下方法引用其他类:

我想在sphinx文档中包含一个代码示例。 但是,我不想通过路径引用文件, 而是通过它的模块名来指定它

也就是说,不要按照这里所指的方式来做

我宁愿这样做(例如)

这是否可以在不编写自定义扩展的情况下实现?
或者,编写这样一个扩展的最简单方法是什么?

您可以使用以下内容引用其他类:

:class:`~module.submodule.Class`

如果您将示例作为doctest添加到类中,那么您就有了一些示例,这些示例可以保证正常工作,因为它们是可直接运行的。

您可以使用以下方法引用其他类:

:class:`~module.submodule.Class`

如果您将示例作为doctest添加到类中,那么您的示例就可以保证工作,因为它们可以直接运行。

文档非常清楚:“文件名”不是“模块”。我想知道是否有我没有注意到的替代方法文档非常清楚:“文件名”不是“模块”.我想知道是否有一个我没有注意到的替代方案这对我的问题有什么帮助?@Ed L:你可以链接到特定的模块并将示例放在那里。如果你使用doctests,它既可以作为文档,也可以作为测试。这对我的问题有什么帮助?@Ed L:你可以链接到特定的模块并将示例放在那里。如果您使用doctest,它既可以作为文档,也可以作为测试。
.. includemodule mymodule.example
:class:`~module.submodule.Class`