python - 更一致的 Sphinx 主题

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 从我的 docstring 生成代码，它看起来像这样(这次我使用默认主题 haiku， rst 或 conf.py 文件没有太多变化):



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

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

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

Answer 1

仅靠 CSS 定制无法解决这个问题。即使您可以使用 ::before之后 ::after选择器，我认为 JavaScript 更适合处理这个问题。

您可以使用 html_js_files 添加自定义 Javascript 文件conf.py 中的选项。使用它应该可以满足您的要求 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

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

备注 :

我正在使用 Alabaster theme .但是这个想法应该适用于大多数主题。但是，您必须根据您的主题编写 custom.js 文件。

我的 custom.js 文件非常简单，没有考虑到所有的可能性。