在Sphinx文檔中，是否可以使用模塊名稱來指定要包含的代碼示例？

我想在我的獅身人面像文件中包含一個代碼示例。但是，我不想通過其路徑來引用該文件，但寧可用其模塊名稱來指定它。在Sphinx文檔中，是否可以使用模塊名稱來指定要包含的代碼示例？

也就是說，是不是做

.. includemodule mymodule.example

.. literalinclude example.py

或

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

的方式，我寧願做（舉例來說）這是可能的在沒有寫定製擴展的情況下做？或者，寫這種擴展的最簡單方法是什麼？

2011-06-02 Ed L

文檔非常清晰：「文件名」不是「模塊」。 – 2011-06-02 19:58:21

我想知道是否有替代品，我沒有注意到 – 2011-06-02 19:59:24

您可以通過使用像這樣引用其他類：

:class:`~module.submodule.Class`

如果添加的例子爲文檔測試的類比你這是保證工作，因爲他們是直接執行的例子。

2011-06-02 20:15:28 Wolph

這是如何幫助我的問題？ – 2011-06-03 00:44:11

@Ed L：您可以鏈接到特定的模塊，並將示例放在那裏。它既可以作爲文檔，也可以作爲測試使用doctests。 – Wolph 2011-06-03 15:37:48

回答