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

Question

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

也就是说，不是按照这里所示的方式来做Showing code examples

.. literalinclude example.py

或者

^{pr2}$

我宁愿这样做（例如）

.. includemodule mymodule.example

不编写自定义扩展是否可以做到这一点？ 或者，编写这样一个扩展的最简单方法是什么？在

Answer 1

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

:class:`~module.submodule.Class`

如果您将示例作为doctest添加到类中，则会有一些示例可以保证正常工作，因为它们是直接可运行的。在