3.6. Sphinx 中的不同引用方式¶
3.6.1. 脚注引用 rubric¶
使用方式为
Lorem ipsum [#f1]_ dolor sit amet ... [#f2]_
.. rubric:: Footnotes
.. [#f1] 第一条尾注的文本.
.. [#f2] 第二条尾注的文本.
效果：
Lorem ipsum [1] dolor sit amet … [2]
Note
使用脚注在 Latex 中出现编译错误。
3.6.2. 参考引用¶
Lorem ipsum [Ref]_ dolor sit amet.
.. [Ref] Book or article reference, URL or whatever.
渲染效果
Lorem ipsum [Ref] dolor sit amet.
3.6.3. 术语引用¶
在术语文件中
.. _glossary:
Glossary
========
.. glossary::
builder
A class (inheriting from that takes
parsed documents and performs an action on them. Normally, builders
translate the documents to an output format, but it is also possible to
use builders that e.g. check for broken links in the documentation, or
build coverage information.
默认配置定义整个 builder 。
[Ref]
Book or article reference, URL or whatever.