.. literalinclude :: from marker

Question

私はpython-sphinxを使ってCコードを文書化しています。私はdoxygenで提供される機能に興味はありませんが、いつかコードベースの抜粋を含めることを望みます。

.. literalinclude::はすばらしいと思われますが、後でコードを編集すると、特に:lines:オプションが少し弱いです。

私は:marker-start: <<<HEREと:marker-end: <<<ENDのような新しいオプションについて考えています。

この動作を達成する最も簡単な方法は何ですか？

Answer 1

start-afterとend-beforeオプションを使用できます。以下は例です。

、EXAMPLE.SQL：

# 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を参照してください。