在Sphinx文档中，是否可以使用模块名称来指定要包含的代码示例？

Question

我想在我的sphinx文档中包含一个代码示例。 但是，我不希望通过其路径引用该文件， 但宁愿用它的模块名称来指定它。

也就是说，而不是按照Showing code examples

指示的方式进行

.. literalinclude example.py

或

.. literalinclude ../../example.py

我宁愿做（例如）

.. includemodule mymodule.example

这可以不编写自定义扩展吗？ 或者，编写此类扩展的最简单方法是什么？

Answer 1

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

:class:`~module.submodule.Class`

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