.. literalinclude :: işaretçilerden

Question

Bir C kodu belgelemek için python-sphinx kullanıyorum. doxygen tarafından sunulan özelliklere ilgi duymuyorum, ancak bazen bazı kod parçalarını kod tabanından eklemek istiyorum.

.. literalinclude:: harika görünüyor, ancak özellikle kod daha sonra düzenlenmişse :lines: seçeneği biraz zayıf.

:marker-start: <<<HERE ve :marker-end: <<<END gibi yeni bir seçenek düşünüyorum.

Bu davranışı gerçekleştirmenin en kolay yolu ne olurdu?

Answer 1

start-after ve end-before seçeneklerini kullanabilirsiniz. Aşağıda bir örnek.

example.txt:

# START 
first line 
second line 
# END 
third line 

Biçimlendirme:

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

Bu çıktıda görünecektir:

first line 
second line 

http://www.sphinx-doc.org/en/stable/markup/code.html#directive-literalinclude bakınız.