使用 Sphinx 和函数指令在侧边栏中显示带有破折号的函数名称

Question

我正在使用 Sphinx 7.2.5 和 Furo 主题，并记录非 Python 的函数，因此名称中可能包含破折号。

function

指令通常按预期工作，只是名称中带有破折号的函数不会显示在侧边栏中。我非常感谢您帮助解决此问题或解决如何解决它！也许有可以使用的转义字符？或者可能是某个地方的错误，但我对 Sphinx 的了解不够，不知道去哪里查找。

这是一个例子：

.. function:: count-non-empty(nodeset)

  Returns the number of non-empty members of ``nodeset``.

您可以在下面看到它的渲染效果https://docs.getodk.org/form-operators-functions/#count，请注意

count-non-empty

不在右侧边栏中。

代码位于 https://github.com/getodk/docs/blob/master/docs/form-operators-functions.rst?plain=1#L353

Answer 1

我们通过Furo主题的讨论区发现这是因为Sphinx默认使用Python域。 Python 不允许在标识符中使用

-

，但将

primary_domain = 'js'

添加到 Sphinx

conf.py

应该可以让它们正常工作。