DocUtils include
指令允许在RST
文档中包含任意文本。问题在于该实现将指定文件限制为与包含文件的位置在同一文档中。这使得难以在许多文档中使用包含文件的外部文件。 DocUtils的标准解决方案是使用称为Standard Definition Files
的东西。不幸的是,这些要求使用此工具的任何人都必须包含DocUtils源代码,这将影响需要此工具的每个最终用户。对于不是程序员并且仅尝试使用Docutils的人(可能在诸如Sphinx之类的环境中),需要源代码不是可接受的解决方案。对于这种情况还有其他解决方法吗?
使用literalinclude
directive使用literalinclude
在文件系统中向上和周围导航。例如:
..
将.. literalinclude:: ../../external-to-project-directory/src/somefile.py
作为文字代码包含在文档中。
如果您想将代码解析为rst,请改用somefile.py
。