本文介绍了Furo Sphinx主题在API文档中大写过多的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我面临着这个问题中讨论的相同问题:Furo Sphinx theme uppercases too much in API documentation。但是,接受的解决方案不起作用,似乎Furo模板以某种方式覆盖了custom.css

感谢在Furo Sphinx theme中实现此简单自定义的任何帮助。

推荐答案

注意:该问题已在Furo 2022.1.2中修复。


好的,尽管上一个问题只有两周多一点的时间,但从那时起已经有五个新的releases of Furo。我将假定您使用的是最新版本,即撰写本文时的2021.11.23。

上一个答案中的变通方法实际上不再起作用。这是因为Furo使this commit中的css选择器更加具体,这意味着it takes precedence超过了由自定义样式定义的不太具体的选择器。

custom.css因此需要更多的活力:

dl.py .field-list dt {
    text-transform: none !important;
}

这只是一种变通办法,并不一定是最好的办法。还应该有一种方法,只选择参数和类型,而不使用参数和类型标题。

然而,这个问题最好由Furo的作者来解决。我之前已经报告了here,但还没有收到回复。正如我在那里提到的,您的另一个选择是使用Napoleon而不是Numpydoc呈现您的NumPy样式的文档字符串。它们在页面上看起来会不同,但大小写问题将不复存在。

这篇关于Furo Sphinx主题在API文档中大写过多的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持!

10-29 12:16