如何将:specialmembers:应用于automodule指令中的一个类?

2024-04-25 03:55:58 发布

您现在位置:Python中文网/ 问答频道 /正文

我正在使用autodocnapoleon为Python2.7项目整理Sphinx驱动的(v1.3.1)文档。在一个模块中,我想用一个automodule::指令记录它,我有一个特定的类,我想对其应用:special-members:标志。用:special-members:标记automodule::会显示模块中所有的特殊项,这是不好的

我该怎么做

添加标有:special-members:autoclass::指令仍然会将“非特殊”文档作为automodule::内容的一部分保留在那里,从而导致重复的内容

我想我可以显式地键入模块中的所有类,除了我在automodule::上的:members:指令中的特殊类之外,但是我必须记住每次向模块添加或删除类时都要更新该列表


Tags: 模块项目文档标记内容标志sphinx记录