Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/python/317.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Python sphinx指令是如何将一个文档包含到另一个文档中的?_Python_Python Sphinx_Restructuredtext - Fatal编程技术网

Python sphinx指令是如何将一个文档包含到另一个文档中的?

Python sphinx指令是如何将一个文档包含到另一个文档中的?,python,python-sphinx,restructuredtext,Python,Python Sphinx,Restructuredtext,在我的文档中,我有一个示例目录 .. literalinclude:: examples/1_basic_usage.py :language: python :linenos: …这非常有效,因为它们是代码,并且格式正确 但是,我想对非代码文档执行一个literalinclude。在整个项目级别,我已经定义了作者,描述,归属,等等,我想(基本上)将它们粘贴到位,但我不知道如何粘贴 希望它与此非工作示例类似: Authors ------- .. literalinclude::

在我的文档中,我有一个
示例
目录

.. literalinclude:: examples/1_basic_usage.py
   :language: python
   :linenos:
…这非常有效,因为它们是代码,并且格式正确

但是,我想对非代码文档执行一个
literalinclude
。在整个项目级别,我已经定义了
作者
描述
归属
,等等,我想(基本上)将它们粘贴到位,但我不知道如何粘贴

希望它与此非工作示例类似:

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

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

显然,这样做的方法是使用
。。包括::
指令

这在他们的文档中并不明显,而且根本没有示例存根

完整的文档可在中找到

“include”指令读取文本文件。指令参数是要包含的文件相对于包含该指令的文档的路径。除非给出了literal或code选项,否则将在指令点的当前文档上下文中解析文件。例如:

第一个示例将在文档级别进行解析,并且可以 因此包含任何构造,包括节标题

.. 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