在reStructuredText中,如何进行“内联”包含外部文档片段?

时间:2015-06-18 17:24:51

标签: restructuredtext

我有一个项目超链接的项目符号列表,其中每篇文章都有一行摘要。而且,我希望我的一行摘要出现在项目符号列表中:

  • Thing1:这是一件事。
  • Thing2:这也是一件事。

因为(1)我的摘要非常复杂,(2)我有很多文章,(3)甚至更多的子弹,我想把摘要放入他们自己的文档片段中并在子弹中“包含”它们清单和文章。但是,不会在reStructuredText中传播:

* `Thing1`_: .. include:: summary-of-thing1.txt
* `Thing1`_: .. include:: summary-of-thing2.txt

文本.. include:: summary-of-thing1.txt最终出现在我生成的HTML文档中,这似乎是因为指令(如.. include::)必须在它们自己的“段落”中,如下所示:

* `Thing1`_:

  .. include: summary-of-thing1.txt

但是,这样做会将我的文档片段放入其自己的段落中,这使它看起来像这样:

何时,我真正想要的是我的摘要与我的超链接出现在同一行。

1 个答案:

答案 0 :(得分:0)

好的,我知道这是.. replace::的用途。可以这样说:

* `Thing1`_: |summary-of-thing1|
* `Thing2`_: |summary-of-thing2|

.. include:: summaries.txt

将摘要放入summaries.txt,如下所示:

.. |summary-of-thing1| replace:: This is a thing.
.. |summary-of-thing2| replace:: This is also a thing.