参考带有Sphinx的外部非Sphinx文档

时间:2019-04-18 11:22:27

标签: python python-sphinx

我正在使用Sphinx编写Python软件包的文档。 利用intersphinx,可以引用外部项目(例如Numpy)中的类。为此,intersphinx读取Numpy的清单文件,该文件位于https://docs.scipy.org/doc/numpy/objects.inv

现在,我还要引用一个项目,该项目的文档不是使用Sphinx构建的,而是Meep documentation使用MkDocs构建,不包含objects.inv文件。因此,不可能使用intersphinx_mapping

是否仍然可以以任何方式映射Meep文档?例如,我将我的函数的文档字符串写为

def f(v):
"""
Parameters
----------
v : meep.Vector3
    Input vector.
"""

目前,Sphinx正在抱怨py:class reference target not found: meep.Vector3

是否可以为Sphinx定义此类并将其链接到https://meep.readthedocs.io/en/latest/Python_User_Interface/#vector3上的文档?

0 个答案:

没有答案