在我的文档中我有一个examples
我可以说的目录
.. literalinclude:: examples/1_basic_usage.py
:language: python
:linenos:
..效果很好,因为它们是代码,并且它们的格式正确为代码。
但是,我想做一个literalinclude
在非代码文档上。在整个项目层面我已经有了AUTHORS
, DESCRIPTION
, ATTRIBUTION
等定义,我想(本质上)将它们粘贴到位,但我不知道如何。
希望和这个类似非工作示例:
Authors
-------
.. literalinclude:: ../../AUTHORS
Attribution
-----------
.. literalinclude:: ../../ATTRIBUTION
显然,做到这一点的方法是.. include:: <path>
指示。
它在他们的文档中并不明显,并且根本没有示例存根。
完整的文档可以在docutils重构文本参考 (#include) http://docutils.sourceforge.net/docs/ref/rst/directives.html#include.
“include”指令读取文本文件。指令参数是要包含的文件的路径,相对于包含该指令的文档。除非给出选项文字或代码,否则文件将在指令所在的当前文档上下文中进行解析。例如:
第一个示例将在文档级别进行解析,并且可以
因此包含任何构造,包括节标题。
.. include:: inclusion.txt
Back in the main document.
This second example will be parsed in a block quote context.
Therefore it may only contain body elements. It may not
contain section headers.
.. include:: inclusion.txt
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)