Python 3.x Pycharm docstring：代码引用和docstring继承

我目前正在使用Jetbrains Pycharm 2017.1.5完成我的项目，记录我所有的python 3.6类和方法，关于docstring格式，我有几点很突出

我想从一些docstring链接到其他方法/函数/类，但我不知道如何做到这一点。的文档非常非常广泛，但它没有提到使用Pycharm引用其他docstring。事实上，该页面中的绝大多数片段甚至在Pycharm中都不起作用。（为什么？）

我发现您可以使用

：class:`

引用类，但是

：class:`

不起作用，类似的命名结构如

：func:`

不会创建超链接。我还看到出现了

：ref:`

，但是这个也不起作用

（如果不是因为这个错误，我会立即切换到（它拥有我想要的一切，而且更简单）：

您需要配置Python2SDK在Ctrl+Q框架中呈现Epydoc docstrings

。）

如果有一种方法可以在子类/重写方法中继承docstring，这将非常有用。如果您将docstring留空，Pycharm会自动执行此操作，这使我认为可以手动执行此操作。但是，再一次，我找不到关于它的任何信息

事情变得如此复杂，如此简单。因此，任何帮助都将不胜感激

我想从一些docstring链接到其他方法/函数/类，但我不知道如何做到这一点

StructuredText文档没有涵盖这一点是正确的，因为它不是StructuredText的一个功能

很可能您（通过某些工具显式地或隐式地）正在使用文档集（docutil的超集），以允许（在许多其他功能中）在不同的文档字符串之间进行引用

狮身人面像（背面勾选引用文本前的

：foo:

）用于不同目的：

• ，对整个文档的引用
• ，任意交叉引用
• …还有很多其他的

对于特定的Python代码，“域”

py

有其自己的特定集合：

• ：py:mod:

  参考模块；可以使用虚线名称。这也应该用于包名称

• ：py:func:

  引用Python函数；可以使用虚线名称。角色文本不需要包含尾随括号以增强可读性；如果add_function_branches config值为True（默认值），则Sphinx将自动添加这些参数

• ：py:data:

  引用模块级变量

• ：py:const:

  引用一个“定义的”常量。这可能是一个不打算更改的Python变量

• ：py:class:

  引用一个类；可以使用虚线名称

• ：py:meth:

  引用对象的方法。角色文本可以包括类型名称和方法名称；如果出现在类型的描述中，则可以省略类型名称。可以使用虚线名称

• ：py:attr:

  引用对象的数据属性

• ：py:exc:

  引用异常。可以使用虚线名称

• ：py:obj:

  引用未指定类型的对象

---

您希望引用在生成文档之前还是之后工作，例如通过Sphinx？Sphinx可以从StructuredText生成输出，例如HTML，该文本支持通过引用任何Python对象。我希望它们在将文档导出为HTML之前能够工作，但如果无法完成，则不会杀死我或任何东西。斯芬克斯可能是我最好的选择。这两件简单的事情在文档预览中似乎不可能实现，这让我很沮丧，现在我必须确定。请每次询问一件事情。docstring继承问题应该是另一个问题。