【问题标题】:How do I get Sphinx to markup C calls in text the way the standard Python docs do?如何让 Sphinx 以标准 Python 文档的方式在文本中标记 C 调用?
【发布时间】:2011-10-07 12:22:01
【问题描述】:

在标准 Python 文档中,系统调用显示为粗体、固定宽度字体。您可以在 asyncore 部分看到这一点,例如,当它提到 select()poll() 时:

http://docs.python.org/py3k/library/asyncore.html

我检查了 asyncore 的源代码,它没有针对这些函数的特殊标记,所以我不确定如何说服 Sphinx 这样做。是否有一个简单的指令可以添加到 index.rst 以使这项工作如我所愿?

【问题讨论】:

    标签: python python-sphinx


    【解决方案1】:

    您在哪里看到 C 函数调用没有特殊标记?当我查看latest source for this file 时,它有:cfunc:'select',我认为这是C 代码的old style Sphinx 标记。最新的做法请阅读The C Domain

    【讨论】:

    • 啊,好吧。出于某种原因,我认为它使用的是 docstring,因为单击文档上的“源代码”链接时获得的源代码以与 HTML 文档相同的文本开头。查看您的链接,我看到了带有文档的单独文件。 :cfunc: 正是我想要的!谢谢!
    猜你喜欢
    • 2015-12-02
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2012-06-10
    • 1970-01-01
    • 2016-05-07
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多