如何在狮身人面像信息字段中使用交叉引用?

时间:2015-09-22 20:58:26

标签: python documentation python-sphinx restructuredtext cross-reference

我想写一些类似的东西:

:param :class:`~src.db.user.User` user:

这样我就可以从参数文档中访问User类。

我的例子不起作用,因为我在冒号包围的表达式中使用冒号。

这真的可以吗?

更新

作为临时解决方案,我只是写道:

:param User user:

狮身人面像神奇地制作了我最初想要的参考!我怎么能确定这将永远有效?如果两个类具有相同的名称会怎么样?

0 个答案:

没有答案