代码之家  ›  专栏  ›  技术社区  ›  oarfish

如何在sphinx:class:指令后添加复数-s

  •  1
  • oarfish  · 技术社区  · 7 年前

    我一直有这个问题,我想写这样的docstring:

    def foo(arg):
       '''Add ``arg`` to the list of :class:`foo.bar.baz.Argument`s.'''
       pass
    

    然而,这不起作用,斯芬克斯会警告

    py:class reference target not found: foo.bar.baz.Argument`s
    

    所以它在治疗 s 在结束后作为类名的一部分。这不会发生在诸如点之类的标点符号上。 . . 除了在类名和复数-s之间加一个空格(看起来很疯狂),还有什么要做的吗?

    1 回复  |  直到 7 年前
        1
  •  3
  •   mzjn    7 年前

    你应该能用 backslash-escaped whitespace .

    def foo(arg):
       '''Add ``arg`` to the list of :class:`foo.bar.baz.Argument`\ s.'''
       pass
    
    推荐文章