【问题标题】:Furo Sphinx theme keeps uppercasing too much in API documentationFuro Sphinx 主题在 API 文档中一直大写太多
【发布时间】:2022-01-02 10:28:27
【问题描述】:

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

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

【问题讨论】:

    标签: themes python-sphinx numpydoc


    【解决方案1】:

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

    上一个答案的解决方法实际上不再有效。这是因为 Furo 使 this commit 中的 CSS 选择器更加具体,这意味着 it takes precedence 相对于自定义样式定义的不太具体的选择器。

    custom.css 因此需要更多魅力:

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

    这只是一种变通方法,不一定是最好的。还应该有一种只选择参数和类型的方法,但保持“PARAMETERS”标题不变。

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

    【讨论】:

    • 谢谢@john-hen!解决方法有效,但最终结果不是我的想法。我们失去了小节标题的大写(例如参数、属性)。我会关注你在 Github 上的报道。
    猜你喜欢
    • 2019-01-27
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2014-06-06
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多