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

Markup:

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