使用Sphinx中的长描述记录参数

Question

我正在使用Sphinx记录我的Python类，有时我想给我的参数提供相当长的描述来详细解释一些内容。不幸的是，Sphinx为我生成了丑陋的输出，浪费了大量的空间并打破了整个页面的外观：

可以看出，Sphinx创建了一个表，然后放入＆＃34;参数＆＃34;标题到左侧单元格，以及实际的参数列表到右侧单元格。但是应该有办法避免完全创建这个表。在使用页面DOM树之后，我终于可以证明我想实现：

是否有内置方法可以执行此操作，或者我必须为Sphinx主题或Sphinx本身创建PR？

Answer 1

将an issue发布到Sphinx错误跟踪器并且没有响应后，我决定推出自己的解决方案（更好的说，黑客）。为了实现我想要的外观，我编写了一个简单的Sphinx扩展，后者处理生成的HTML代码。它可以在PyPI上找到：

• https://pypi.python.org/pypi/sphinxcontrib.divparams
• https://pythonhosted.org/sphinxcontrib.divparams/

这似乎不是解决问题的最佳方式，但我想改变的行为在docutils中进行了深刻的硬编码，而不是Sphinx。