.. literalinclude :: from markers

Question

我正在使用python-sphinx来记录C代码。我对doxygen提供的功能不感兴趣，但我有时希望在代码库中包含一些代码片段。

.. literalinclude::看起来很棒，但:lines:选项有点弱，特别是如果之后编辑代码。

我正在考虑一个新选项，例如:marker-start: <<<HERE和:marker-end: <<<END。

实现此行为的最简单方法是什么？

Answer 1

您可以使用start-after和end-before选项。以下是一个例子。

example.txt中：

# START
first line
second line
# END
third line

标记：

.. literalinclude:: example.txt
   :start-after: # START
   :end-before: # END

这将出现在输出中：

first line
second line

请参阅http://www.sphinx-doc.org/en/stable/markup/code.html#directive-literalinclude。