스핑크스와 함께 numst docstring에 중첩리스트를 올바르게 추가하는 방법

Question

어떻게하면 다음과 같은 결과를 얻을 수 있는지 궁금합니다. 나는 자동 문서화를 생성하기 위해 스핑크스 autodoc과 함께 numpy docstring 스타일을 사용하고있다. 그러나, 나는 출력에 중첩 된 목록을 가지고에 struggeling 해요 :

Attributes 
---------- 
attribute 1: pandas data frame 
    * `index:` Array-like, integer valued representing 
      days. Has to be sorted and increasing. 
    * `dtype:` float64. Value of temperature. 
    * `columns:` location description, e.g. 'San Diego' 
attribute 2: `int` 
    nice and sunny days in California 

이 문서화 문자열의 출력은 해제 완료입니다.

가

def generate_temp(self, n, freq, very_long_variable_name, 
        type_temp=None, method=None): 

또한 여기 스핑크스 완전한 기능을 인식하지 않고, 독립적으로 제 라인 처리 :이 함수의 설명은 복수의 라인에 걸쳐 다른 우선 속성 1.

대한리스트를 인식하지 먼저.

내 서식이 잘못 되었습니까?

Answer 1

NumPy docstrings in Napoleon을 사용하면 콜론의 양쪽에 공백이 있어야합니다. 이 시도 :

Attributes 
---------- 
attribute 1 : pandas data frame 
    * `index:` Array-like, integer valued representing 
     days. Has to be sorted and increasing. 
    * `dtype:` float64. Value of temperature. 
    * `columns:` location description, e.g. 'San Diego' 
attribute 2 : `int` 
    nice and sunny days in California 

을 그 작동 경우 example NumPy strings는 단락이 지원하고 있음을 나타냅니다으로 나는 모른다. 목록에 대해서는 언급하지 않습니다.