如何在长函数签名中使用换行符，并在Sphinx autodoc中对其进行格式格式化

Question

我有一个带有带有类型提示的长签名的函数，例如

def set_parameters(
        tokenizer: Union[None, "Tokenizer", str] = None,
        vocab: Optional["Vocab"] = None,
        vocab_from: Optional[Dict[str, str]] = None,
        max_sent_length: Optional[int] = None,
        max_turn_length: Optional[int] = None,
        convert_to_lower_letter: Optional[bool] = None,
        weak=False) -> "FieldContext":

我使用Sphinx autodoc生成文档字符串。

.. autofunction:: set_parameters

然后，Sphinx将忽略换行并在一行中描述该功能。

set_parameters(tokenizer: Union[None, Tokenizer, str] = None, vocab: Optional[Vocab] = None, vocab_from: Optional[Dict[str, str]] = None, max_sent_length: Optional[int] = None,    max_turn_length: Optional[int] = None, convert_to_lower_letter: Optional[bool] = None, weak=False) -> FieldContext:

这非常丑陋且难以阅读。我想要的是要么跟随代码中的换行符，要么自动执行一些换行符。有什么方法可以实现吗？

Answer 1

一种快速而肮脏的选择是使用CSS：