我正在使用python-sphinx用于记录 C 代码。我对 doxygen 提供的功能不感兴趣,但是有时我想包含代码库中的一些片段。
.. literalinclude::
看起来不错,但是 :lines:
选项有点弱,特别是如果之后编辑代码。
我正在考虑一个新选项,例如 :marker-start: <<<HERE
和:marker-end: <<<END
。
实现此行为的最简单方法是什么?
最佳答案
您可以使用start-after
和end-before
选项。下面是一个例子。
示例.txt:
# START
first line
second line
# END
third line
标记:
.. literalinclude:: example.txt
:start-after: # START
:end-before: # END
这将出现在输出中:
first line
second line
参见https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude .
关于python-sphinx - ..literalinclude::from 标记,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/36135982/