我正在使用 Sphinx 从代码生成文档。有谁知道是否有办法控制从默认参数生成的 float 的格式。

例如，如果我有以下功能:

def f(x = 0.97):
    return x+1

生成的文档最终看起来像:

foo(x = 0.96999999999997)

显然这是一个浮点精度问题，但是有没有办法让文档看起来不那么难看？

最佳答案

您可以使用 .. autofunction:: 指令覆盖函数签名。因此，为了解决您的示例，在模块 bar 中定义为 foo(x=0.97) 的函数:

.. automodule:: bar

   .. autofunction:: foo(x=0.97)

生成的文档将使用提供的签名，而不是具有非常长数字的解释版本。

您可以使用 .. autoclass:: 和 .. automethod:: 等等效地执行此操作。此用法记录在 this part of the sphinx.ext.autodoc 的“选项和高级用法”中。文档。

https://stackoverflow.com/questions/7259971/