当括号括起来时,结构成员会断裂

时间:2014-08-19 10:30:25

标签: c python-sphinx

示例:

.. member:: CK_UTF8CHAR model[16]

给我带有粗体和超链接的类型和名称。

实际上我们被迫使用这样的案例:

.. member:: model

因为否则它将是不正确的(使用它没有数组和相同的类型)。

1 个答案:

答案 0 :(得分:1)

嗯,这似乎是Sphinx中的一个真正的错误。我reported确认了这一点。我现在想出一个小的解决方法,但它更像是一个拐杖。只需将以下内容添加到您的Sphinx主题的layout.html文件中:

<script>
    $('dl.member dt').each(function() {
      $(this).find('big:first').text('[')
      $(this).find('big:last').text(']')
    });
</script>

现在您可以在断开的结构中使用括号而不是括号:model(16)变为model[16]label(\ )变为label[],但仅在.. member::指令中

我知道这不是一个非常优雅的解决方案,但它可以作为临时修复,直到错误得到解决。