如何在Sphinx中自定义Python域

Question

我想自定义Sphinx Python域，以识别方法的文档字符串中的自定义字段，并为其生成自定义HTML。

例如，假设我想为模块中的每个方法添加一个类别。我希望能够编写这样的文档字符串：

def func():
“””
Does something
:category: A/B/C
“””
…

然后在生成的autodoc上显示自定义HTML。

这可能吗？

Answer 1

是的，但它需要代码(自定义扩展(，可能并不容易。

可能有一种更简单的方法，但通过将PyClassLike子类化，可能会更改doc_field_types的值，并在conf.py中的setup(app)函数中将其注册到app.add_directive_to_domain("py", "class", YourClass, override=True)，您可能会得到所需的内容。