ITPub博客

首页 > 数据库 > > sphinx 中的三种引用

sphinx 中的三种引用

作者:u_9ff4c058a0e0 时间:2022-03-21 14:16:56 0 删除 编辑

脚本引用 rubric

使用方式为

Lorem ipsum [#f1]_ dolor sit amet ... [#f2]_


.. rubric:: Footnotes

.. [#f1] 第一条尾注的文本.
.. [#f2] 第二条尾注的文本.


渲染效果为:

参考引用

Lorem ipsum [Ref]_ dolor sit amet.


.. [Ref] Book or article reference, URL or whatever.



渲染效果


术语引用

默认配置定义整个 :term:`builder`

在术语文件中

.. _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.


渲染效果为

来源 https://zhuanlan.zhihu.com/p/447737693

来自 “ ITPUB博客 ” ,链接:https://blog.itpub.net/69999831/viewspace-3147514/ ,如需转载,请注明出处,否则将追究法律责任。

请登录后发表评论 登录
全部评论

注册时间:2022-02-11

  • 博文量
    1828
  • 访问量
    20586