Reference Sphinx,对函数docstring中类的引用
编辑:首先,我很抱歉,我发现这是一个重复的未回答的问题。 我添加了html输出的完整示例代码和图像 我使用sphinx来记录python项目。我有一个引发多个自定义异常的函数。因此,我的代码如下所示:Reference Sphinx,对函数docstring中类的引用,reference,python-sphinx,docstring,Reference,Python Sphinx,Docstring,编辑:首先,我很抱歉,我发现这是一个重复的未回答的问题。 我添加了html输出的完整示例代码和图像 我使用sphinx来记录python项目。我有一个引发多个自定义异常的函数。因此,我的代码如下所示: class MyException1(Exception): """ My Exception 1 """ pass class MyException2(Exception): """ My Exception 2 """ pa
class MyException1(Exception):
"""
My Exception 1
"""
pass
class MyException2(Exception):
"""
My Exception 2
"""
pass
def process_finished(path):
"""
Description
:param path: Path to the finished file
:type path: string
:returns: None
:raises MyException1: My first exception
:raises MyException2: My second exception
"""
print(path)
def process_finished2(path):
"""
Description
:param path: Path to the finished file
:type path: string
:returns: None
:raises: :exc:`MyException1`: My first exception
:raises: :exc:`MyException2`: My second exception
"""
print(path)
然后,输出为html,如下所示:
我关心的是函数的提升块process\u finished
和process\u finished2
。我希望文档看起来像第一个函数中的文档,但例外是process\u finished2
中的引用
我猜默认情况下sphinx是不可能的,尽管这在没有任何返回类型引用的情况下也可以工作。谢谢您的帮助。您的自定义异常是否有docstring?是的,我可以正常引用。如果我这样做,它只会破坏Raises部分的格式。到底发生了什么?您的第一个示例(没有
:class
标记)适合我。也许你可以发布一个截图。好的,我添加了一个完整的虚拟代码和输出图像。希望解释得更清楚。