Python Sphinx自动记录模块变量

我试图使用Sphinx来记录一个python模块，它本质上是一系列变量赋值。具体而言，它们是seaborn生成的RGB代码列表，用于seaborn和matplotlib。例如：

import seaborn as sns

#: List of RGB tuples for 10 color palette
PRIMARY_10 = sns.color_palette(['#000000', '#000000', '#000000', '#000000', '#000000', '#000000', '#000000', '#000000', '#000000', '#000000'])

#: List of RGB tuples for 5 color palette
PRIMARY_5 = sns.color_palette(['#000000', '#000000', '#000000', '#000000', '#000000'])

以下方法可行，但这并不是我想要的：

color_palettes
==============
.. automodule:: cy.basics.color_palettes
   :members:

color_palettes

cy.basics.color_palettes.PRIMARY_10
List of RGB tuples for 10 color palette
../_images/primary-10.png

cy.basics.color_palettes.PRIMARY_5
List of RGB tuples for 5 color palette
../_images/primary-5.png

它生成的页面看起来像：

color_palettes

cy.basics.color_palettes.PRIMARY_10 = [(0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0)]
List of RGB tuples for 10 >color palette 

cy.basics.color_palettes.PRIMARY_5 = [(0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0)] 
List of RGB tuples for 5 color palette

我希望文档中省略赋值的右侧，即元组的长列表。我还想包括一个彩色托盘下的每个图像。我想我可以这样做：

color_palettes
==============
.. automodule:: cy.basics.color_palettes
    .. autodata:: PRIMARY_10 
        :annotation:
        .. image:: primary-10.png
    .. autodata:: PRIMARY_5
        :annotation:
        .. image:: primary-5.png

结果很接近，但它通过变量的描述省略了，并使用seaborn color_Palate的描述。见下文：

color_palettes

cy.basics.color_palettes.PRIMARY_10
Set the color palette in a with statement, otherwise be a list.
../_images/primary-10.png

cy.basics.color_palettes.PRIMARY_5
Set the color palette in a with statement, otherwise be a list.
../_images/primary-5.png

无论我是将注释格式与#：或docstring一起使用，这都是结果。在狮身人面像中这样做的正确方式是什么

下面是我想要的示例：

color_palettes
==============
.. automodule:: cy.basics.color_palettes
   :members:

color_palettes

cy.basics.color_palettes.PRIMARY_10
List of RGB tuples for 10 color palette
../_images/primary-10.png

cy.basics.color_palettes.PRIMARY_5
List of RGB tuples for 5 color palette
../_images/primary-5.png

---

autodata

从

seaborn.paletes.\u colorplete

类中拾取文档字符串，而不是

PRIMARY\u 5

和

PRIMARY\u 10

的文档字符串。这对我来说似乎是个bug。谢谢mzjn，我希望有人能给我一个答案，但看起来我应该提交一份bug报告，你可以使用

。。literalinclude:：

，它可以将代码作为文本放到html页面中。你可以看看结果会是什么样子。