如何解决sphinx 中是否有换行符或功能可以将长行渲染为漂亮的 HTML?
我正在尝试使用 sphinx 记录以下 python 函数。但是,其中一行很长,会导致 HTML 呈现非常糟糕。下面是函数,问题出现在包含 doctest [e.g. >>> perf(pd.DataFrame({'c' : [100,101,98,105.5]}),return_vals = True)))
].
def perf(df,price_column = 'c',return_vals = False):
''' Compute the log return using security price
:Parameters:
df: pandas dataframe
input object
price_column: string
input column/series that contains the price data
return_vals: Boolean
input flag that determins whether log returns are reported to the console
:Returns:
df[price_column]: column/series
output object
:Examples:
>>> perf(pd.DataFrame({'c' : [100,return_vals = True)))
'''
df['r'] = np.log(df[price_column]).diff()
if return_vals:
return df['r']
考虑到这一点,是否有一种换行符或方法可以避免这个问题并以一种很好的格式呈现 HTML?
附上包含该行的糟糕渲染的屏幕截图以及删除该行后的改进。
正在寻找一种方法来包含这一长行,并且仍然能够以 HTML 格式呈现文档,从而使其具有良好的格式。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。