我试图用狮身人面像记录我的主程序。我不知道如何使用autodoc
功能来利用literalinclude
的功能,包括start-after
和end-before
。有人知道如何使用autodoc执行此操作吗?我只能使用它来记录一个类或一个类模块。
Main.py [待记录]
#Label_BasicLibraries_Start
IGNORE:
This libraries are imported basic libraries.
IGNORE:
import time
import json
import urllib.parse
import random
from functools import reduce
import os.path
#Label_BasicLibraries_End
这是我目前正在使用的代码:
Title Example
=======================================================
This is beautiful code.
.. literalinclude:: Main.py
:language: python
:start-after: #Label_BasicLibraries_Start
:end-before: #Label_BasicLibraries_End
:linenos:
我可以使用这两种方法来过滤整个程序。有没有一种方法可以排除以固定标记开头或其他标记之间的特定行?像this example中的文档字符串一样?
非常感谢您的帮助!