狮身人面像:将脚注写到位,最后显示

时间:2016-10-24 22:53:50

标签: python-sphinx restructuredtext

我希望能够在引用脚注的位置创作脚注,但只在文档末尾显示脚注,.. rubric: Footnotes出现。

像这样:

Lorem Ipsum[#lorem]_ dolor sit blah blah.

.. [#lorem]

   The footnote text here.

The next paragraph. Salve regina mater misericordiae, vita dulcedo.

.. rubric: Footnotes

期望的输出:

Lorem Ipsum ^ 1 dolor坐等等。

下一段。 Salve regina mater misericordiae,vita dulcedo。

脚注:
 1脚注文本在这里。

根据the docutils docs,这应该是可能的:

  

脚注可能出现在文档的任何位置,而不仅仅是最后。   它们在加工输出中的出现位置和方式取决于   处理系统。

但是我找不到如何使处理系统(Sphinx,使用内置的make html)只将它们放在底部,而不是放在它们出现的任何地方。

1 个答案:

答案 0 :(得分:0)

我使用了脚注方法,但是,您必须小心放置引用的位置。所以,我的 modules.rst 看起来像这样:

Brief
-----

.. automodule:: modules
   :members:
   :undoc-members:
   :show-inheritance:


Sub modules
-----------

.. toctree::
   :maxdepth: 4

   modules.ahp
   modules.grid

Plot module
-------------------

.. automodule:: modules.Plot
   :members:
   :undoc-members:
   :show-inheritance:

Score module
-------------------

.. automodule:: modules.Score
   :members:
   :undoc-members:
   :show-inheritance:

Skillset module
-------------------

.. automodule:: modules.Skillset
   :members:
   :undoc-members:
   :show-inheritance:

util module
-------------------

.. automodule:: modules.util
   :members:
   :undoc-members:
   :show-inheritance:

|hr|

.. rubric:: Footnotes

.. [#euclidian] `Wikipedia <https://en.wikipedia.org/wiki/Dot_product#Geometric_definition>`_

由于我的 utils 模块包含我使用脚注的函数,所以它的工作方式与预期一致。 (它只是在当前页面中创建对 div 的引用)