如何在 Sphinx 中使用数值作为引用链接而不是脚注?

Posted

技术标签:

【中文标题】如何在 Sphinx 中使用数值作为引用链接而不是脚注?【英文标题】:How to use numeric values for citation links instead of footnotes in Sphinx? 【发布时间】:2018-04-16 14:40:06 【问题描述】:

我正在使用Sphinx 创建一个文档,我在其中引用具有标准数字引用方式的论文,例如

file1.rst

骨骼、细胞外基质[2]、体液和扩散性化学物质[3]

references.rst

.. [2] 默克斯,R.M.H.,纽曼<MoreText>

.. [3] 图灵,上午 <MoreText>

但它不起作用。我看到数字引用仅用于脚注,对于引用,您必须使用 documentation 中提到的字母数字文本。

我相信很多人都使用编号引用来引用。有什么办法可以做到这一点?

【问题讨论】:

不是开箱即用的。我认为项目的问题跟踪器中有一个相关项目。 github.com/sphinx-doc/sphinx/issues/4131 【参考方案1】:

可以使用 Matthias C.M.Troffaes 的 sphinxcontrib-bibtex,它依赖于 BibTex 文件来存储引用。

安装它(见上面的链接)并添加

extensions = ['sphinxcontrib.bibtex']

到您项目的conf.py 文件。

添加参考书目页面

.. bibliography:: /path/to/bibtex/file.bib
   :style: plain

“plain”样式是典型的数字引用样式。请注意,关于乳胶的使用,您不要自己输入数字。引用完成为

Sphinx 非常适合做文档:cite:`sphinx_doc_web`

并且分机会适当地放置号码。

【讨论】:

以上是关于如何在 Sphinx 中使用数值作为引用链接而不是脚注?的主要内容,如果未能解决你的问题,请参考以下文章

如何在 Sphinx 中交叉引用 autodoc 生成的函数?

强制 Sphinx 在 Python 文档字符串中解释 Markdown 而不是 reStructuredText

交叉引用装饰器

在 Sphinx 中,如何在没有大量开销的情况下创建可链接的“术语”部分?

json字段如何在javascript中直接引用而不是作为字符串? [关闭]

如何将对不同变量/类属性的引用作为方法参数而不是值?