记录枚举类的困难？

Question

我试图记录我正在维护的一个模块，我发现很难正确记录我的枚举类。例如，这里有一个我想正确记录的（source）：

class QOSLevel(Enum):
    '''Quality of service levels'''

    #: 500ms (fastest available)
    EXPRESS = '0'                  

    #: 750ms                       
    REAL_TIME = '1'                

    #: 1000ms                      
    FAST = '2'                     

    #: 1500ms                      
    MODERATE = '3'                 

    #: 3000ms                      
    SLOW = '4'                     

    #: 5000ms                      
    DELAYED = '5'                  

我的文档在这里（source）：

.. autoclass:: tda.streaming.StreamClient.QOSLevel 
  :members:                                        
  :undoc-members:                                  
  :member-order: bysource                          

输出如下所示：

这里有两件事马上就错了：

• 首先，我设置的文档字符串没有呈现。我试图遵循适用于泛型属性的some advice I've received before，但似乎枚举的处理方式有所不同

• 其次，似乎:member-order: bysource指令被忽略了。我试着在这里和conf.py中设置它，但这两个地方似乎都不允许以正确的顺序发出字段

我正在使用SphinxV3.0.4来实现它的价值。您可以通过将以下内容复制粘贴到终端中来尝试复制错误：

git clone https://github.com/alexgolec/tda-api.git
cd tda-api
git checkout remotes/origin/autodoc-bysource-not-working
virtualenv -v virtualenv
source virtualenv/bin/activate
pip install -r requirements.txt
make -f Makefile.sphinx html
open docs-build/html/streaming.html  # Only works on Mac OS    

Answer 1

问题是QOSLevel类嵌套在StreamClient类中。以下工作（注意冒号）：

.. autoclass:: tda.streaming::StreamClient.QOSLevel

见How to document nested classes with Sphinx's autodoc?