Python sphinx 自动链接Sphinx文档中代码示例中的函数/类

Python sphinx 自动链接Sphinx文档中代码示例中的函数/类,python-sphinx,Python Sphinx,我正在使用Sphinx构建代码文档 让我们假设在某个时刻有一个类foobar.Foo的文档,例如 .. autoclass:: foobar.Foo :members: 在另一个地方,我有一个代码示例(包括使用literalclude),其中包含以下行 foo = foobar.Foo() 有没有办法让代码示例中的foobar.Foo自动链接到该类的文档,就像使用 :class:`foobar.Foo` 在普通文本中?否。literalinclude不解析代码。@StevePierc

我正在使用Sphinx构建代码文档

让我们假设在某个时刻有一个类
foobar.Foo
的文档,例如

.. autoclass:: foobar.Foo
   :members:
在另一个地方,我有一个代码示例(包括使用
literalclude
),其中包含以下行

foo = foobar.Foo()
有没有办法让代码示例中的
foobar.Foo
自动链接到该类的文档,就像使用

:class:`foobar.Foo`

在普通文本中?

否。literalinclude不解析代码。@StevePiercy在可能的情况下,是否有一种替代方法来替代
literalinclude
?是否是您在寻找的?@kuropan方向正确,但如果我正确理解文档,这会为文件生成单独的页面?我正在寻找的是一种解决方案,我可以在一个页面中嵌入简短的代码片段,周围有文本(比如
literalinclude
code block
)。@luator是的,我也在寻找同样的东西,但也不确定viewcode是否在这样做(我读到了关于它的矛盾的东西)。我们还可以看看sklearn的
setup.py
,因为他们似乎完全启用了这一功能:不。literalinclude不解析代码。@StevePiercy在可能的情况下,除了
literalinclude
,还有其他选择吗?可能是您在寻找吗?@kuropan方向正确,但如果我正确理解文档,这会为文件生成单独的页面吗?我正在寻找的是一种解决方案,我可以在一个页面中嵌入简短的代码片段,周围有文本(比如
literalinclude
code block
)。@luator是的,我也在寻找同样的东西,但也不确定viewcode是否在这样做(我读到了关于它的矛盾的东西)。我们还可以看看sklearn的
setup.py
,因为它们似乎正好启用了此功能: