我目前正在使用Sphinx编写Python模块的文档。在
在记录一些函数时,如果发现自己在写一些东西,比如:
"""
Some documentation.
:param foo: My param.
:raises my_module.some.wicked.but.necessary.hierarchy.MyException: Something bad happenned.
"""
这很好,Sphinx甚至将my_module.some.wicked.but.necessary.hierarchy.MyException
链接到我的异常类的文档。在
但是,我在这里可以看到两个问题:
第二点使得输出很难阅读,一点也不好看。它会使文档变得杂乱无章,而且不会带来太多东西,因为您可以单击链接来获得异常类的完整定义。在
我试图将它写为一个相对路径(例如使用..hierarchy.MyException
,但是Sphinx找不到类,链接也会断开)。在
当我引用我的异常类时,有没有办法定义一个默认的别名/标题来代替完整的路径?很明显,我希望链接保持原样:我只想要一个更好(短)的标题。在
如果没有,Sphinx中是否有一个选项告诉它避免显示某些对象的完整模块路径?某种选择?在
尝试:
相关问题 更多 >
编程相关推荐