Question

在我的文档中，我有一个examples目录，我可以说，

.. literalinclude:: examples/1_basic_usage.py
   :language: python
   :linenos:

..效果很好，因为它们是代码，并且它们的格式正确为代码。

但是，我想对非代码文档执行literalinclude。在整个项目级别，我已经定义了AUTHORS，DESCRIPTION，ATTRIBUTION等，我希望（基本上）将它们粘贴到原位，但我不知道如何

希望它类似于非工作示例：

Authors
-------
.. literalinclude:: ../../AUTHORS

Attribution
-----------
.. literalinclude:: ../../ATTRIBUTION

Answer 1

显然，执行此操作的方法是使用.. include:: <path>指令。

它没有 - 在他们的文档中显而易见，并且根本没有示例存根。

可以在docutils reStructuredText reference (#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

将文档包含到另一个文档中的sphinx指令是什么？

1 个答案: