python - literalinclude : how to include only a variable using pyobject?

Question

我正在使用 Sphinx 来记录我的部分 Python 代码。

我只想在我的文档中包含我的类中的一个变量。

例如，我试过这个但没有成功:

.. literalinclude:: MyClass.py
    :pyobject: MyClass.aVariable
    :language: python

我只看到一个解决方案，但如果我的代码在下一个版本中更改，变量的行号可能会更改:

.. literalinclude:: MyClass.py
    :language: python
    :lines: 2-3

是否有另一种解决方案来仅过滤此变量？

Answer 1

作为解决方法，我使用了 start-after 和 end-before 选项，但我必须在代码中的变量前后添加两条注释。

例如:

类(class):

class MyClass():
    # Start variables
    aVariable = {"a":123 , "b":456}
    # End variables 
        def __init__(self):
            pass

RST 文件:

.. literalinclude:: MyClass.py
    :start-after: # Start variables 
    :end-before: # End variables 
    :language: python

它并不完美，但它确实有效。