python - 记录枚举类有困难吗？

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中都进行设置，但两个地方似乎都不允许以正确的顺序发出字段。

我使用 sphinx v3.0.4 是为了它的值(value)。您可以尝试通过将以下内容复制粘贴到终端来复制错误:

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? .