2017-01-30 50 views
0

我在RST格式编写文档,并使用狮身人面像生成HTML。重用文本RST的狮身人面像文档

我希望能够在RST文件中编写段落,并在同一文件夹中的不同RST文件中重复使用同一段落。我想要重复使用,如果我在原始段落中进行更改,它应该在我使用Sphinx生成HTML时引用的所有其他文件中自动更改。

是否有任何RST语法来做到这一点?任何帮助表示赞赏。

回答

3

可以使用include directive

对于基本包括引用您想重用如下段落:

Some text 

.. include:: /path/to/file_to_include.rst 

More text 

在我们的例子中,file_to_include.rst内容Included text。 斯芬克斯将生成:

Some text 

Included text 

More text 

正如可以在docutils的文档(上面链接)中看到的,可以选择指定的一组的选项,例如,以限制附带的文本的行范围的。

+0

谢谢!我可以在完整的文本中添加并添加开始行或结束行。但是,当我将起始行和结束行都作为参数添加以显示范围时,它不会显示出来。这里是我使用的语法:.. include :: includedtext.rst :start-line:11 \t \t:end-line:14 – Ashwin

+0

它对我来说工作正常。你能链接到一个示例项目,我可以重现这个问题并提供你的Sphinx/Docutils版本吗? 您确定您正确指定行号吗?行数从0开始。“终点”不包含在内。 –

+0

它的作品谢谢! – Ashwin