更一致的狮身人面像主题

Question

考虑以下函数

# in mymodule.py:

def myfunc(num,mystring):
    """
    replicates a string

    :param num: a positive integer
    :param mystring: a string
    :return: string concatenated with itself num times

    :Example:
        >>> num = 3
        >>> mystring = "lol"
        >>> myfunc(num, mystring)
        "lollollol"
    """
    return num*mystring

如果我使用 Sphinx 从我的文档字符串生成代码，它看起来像这样（这次我使用默认主题 haiku，rst 或 conf.py 文件中没有太多更改）：

是否有任何主题 - 或任何其他解决方法 - 可以解决我用颜色指示的问题？

我尝试了不同的方法，但都没有奏效，但我无法获得 1.-4 的任何分数。上班。

编辑 我的想法是我不想编辑 HTML，这很麻烦。我只想对我的 Sphinx docs 目录中的 conf.py 和 index.rst 文件进行更改，以便进行上述更改。

Answer 1

单独的 CSS 自定义无法解决这个问题。即使您可以使用::before 和::after 之后的选择器，我认为JavaScript 更适合处理这个问题。

您可以使用 conf.py 中的 html_js_files 选项添加自定义 Javascript 文件。使用它应该可以满足您的要求 1、2 和 3。

#  ...

html_js_files = ['custom.js']

# ...

如果您在 conf.py 中使用上述代码，那么您的 custom.js 文件应位于以下位置

docs/
  _static/
    custom.css
    custom.js
  _templates/
  index.rst
  api.rst
  ...

一个例子

添加之前custom.js

我的 custom.js 文件

window.onload = function () {
    // Change 'Parameters' to 'Arguments' 
    first_dt_elements = document.querySelectorAll('dl.field-list > dt:first-child');
    for(let i = 0; i< first_dt_elements.length; i++){
        first_dt_elements[i].innerText="Arguments";
    }
    // arguments same font and typeface etc..
    dl_methods = document.querySelectorAll('dl.function, dl.method');
    parameter_texts = []
    for(let i = 0; i< dl_methods.length; i++){
        params = [];
        param_elems=dl_methods[i].querySelectorAll('.sig-param');
        for (let j = 0; j< param_elems.length; j++){
            params.push(param_elems[j].innerText);
        }
        for( let k=0; k<params.length; k++){
            str = dl_methods[i].innerHTML;
            dl_methods[i].innerHTML= str.replace(
                RegExp(params[k], "g"), 
                '<span style="color:red;font-family:monospace;font-style:normal;">'
                + params[k] +
                '</span>'
            );
        }
    }
}

再次构建html后

关于可选要求4

Sphinx 使用 pygments 来突出显示语法。如果对此不满意，可以使用Highlightjs、Prismjs、Google code prettify 等。通过html_js_files 下载并包含它们。但这些也是 语法 荧光笔。高亮变量的语义荧光笔可用于 python，但我还没有听说过任何可以与 Sphinx 一起使用的东西。

注意：

• 我正在使用Alabaster theme。但是这个想法应该适用于大多数主题。但是，您必须根据您的主题编写 custom.js 文件。
• 我的 custom.js 文件非常简单，并没有考虑到所有可能性。