sphinx-如何包括Python函数作为源代码

问题描述 投票:0回答:1

Sphinx非常适合链接到特定的Python对象。

例如,写作

:func:`foo.bar`

将直接链接到bar中的foo.py功能。我想要相同的功能,但是,我不想创建可点击的链接,而是希望它成为bar()的代码。

.. code-block:: language指令要求您手动编写要添加的代码。但是我想使用intersphinx链接到外部Sphinx项目中已经存在的代码,而不是自己编写代码。 :mod::func:和其他仅创建链接,实际上不包括源代码。

也有.. literalinclude:: filename,但在我的情况下,我无法使用它,因为该功能来自Sphinx项目之外(它是使用intersphinx链接的,并不属于实际项目)。即使.. literalinclude:: filename可以以某种方式跨项目工作,但我认为我仍然需要使用:lines:来过滤每个函数,这将是跟踪的巨大痛苦。

如何通过其名称空间路径引用函数/类,并使用其将其源代码直接添加到sphinx rst文件中? (不是文字链接,而是文字代码。)>

Sphinx非常适合链接到特定的Python对象。例如,编写:func:`foo.bar`将直接链接到foo.py中的bar函数。我想要相同的功能,但不是...

python python-sphinx
1个回答
1
投票

没有人回答,所以我做了我自己的:https://github.com/ColinKennedy/sphinx-code-include

© www.soinside.com 2019 - 2024. All rights reserved.