.. literalinclude:: 来自标记
.. literalinclude:: from markers
我正在使用 python-sphinx for documenting a C code. I am not interested in features offered by doxygen,但有时我想包含代码库中的一些片段。
.. literalinclude::
看起来不错,但是 :lines:
选项有点弱,尤其是在之后编辑代码时。
我正在考虑 :marker-start: <<<HERE
和 :marker-end: <<<END
等新选项。
实现此行为的最简单方法是什么?
您可以使用 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
参见 https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude。
我正在使用 python-sphinx for documenting a C code. I am not interested in features offered by doxygen,但有时我想包含代码库中的一些片段。
.. literalinclude::
看起来不错,但是 :lines:
选项有点弱,尤其是在之后编辑代码时。
我正在考虑 :marker-start: <<<HERE
和 :marker-end: <<<END
等新选项。
实现此行为的最简单方法是什么?
您可以使用 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
参见 https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude。