Question

我在RTD上记录了一个python模块：http://modernglexttextools.readthedocs.io

这是another module的扩展，我想在两者之间建立联系。我希望参数和返回类型作为链接。这是一个example。

我的 conf.py

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.githubpages',
    'sphinx.ext.intersphinx',    # added this but does not help
    'sphinxcontrib.napoleon'
]

以下是链接外部类的方法的示例。外部类是ModernGL.Context。我不确定是否必须配置此类记录的位置。但它应该指向this link。

def load(filename, convert=None, ctx=None) -> ModernGL.Texture:
    '''
        Load a texture. If ctx is ``None`` the default_context is used.

        Args:
            filename (str): The name of the file to load.

        Keyword Args:
            convert (str): Convert the texture before loading. Possible values are: ('L', 'RGB', 'RGBA')
            ctx (:py:class:`ModernGL.Context`): The Context to use for loading the texture.

        Returns:
            :py:class:`ModernGL.Texture`: The texture.

        Examples:

            .. code-block:: python

                import ModernGL
                from ModernGL.ext import textools

                ctx = ModernGL.create_standalone_context()
                # ctx = ModernGL.create_context()

                texture = textools.load('brick.jpg', ctx=ctx)
                texture.use()
    '''

Answer 1

如果我理解你的问题，听起来你只想在你的文档中添加一个链接，而不是在你的文档中包含他们的文档。

在extensions中将Sphinx扩展程序添加到conf.py只是其中的一部分。您还需要定义一个intersphinx_mapping，它是一个dict，告诉扩展程序在哪里查找外部文档。例如：

# Looks for objects in external projects
intersphinx_mapping = {
    'moderngl': ('https://moderngl.readthedocs.io/en/stable/', None),
}

最后要创建特定链接，请使用以下语法：

:py:class:`ModernGL.Context`

此外，假设目标存在，可以使用以下语法链接到任意targets：

:ref:`My Label <moderngl:MyArbitraryTarget>`

如何使用python sphinx链接到外部库？

1 个答案: