내부 들여 쓰기가있는 RST 코드 블럭

Question

Sphinx를 사용하여 사전을 반환하는 메소드를 문서화하고 있습니다.

def do_stuff(foo, bar): 
    """Do some stuff 

    :param foo: I'm an argument 
    :param bar: So am I 

    :return: dict:: 

     { 
      "success": (Boolean) True if stuff was done 
      "meta": { 
       "aaa": A nested return value 
       "bbb": Another nested return value 
      } 
     } 
    """ 

사전 개체의 서식이 꺼 같습니다

가 가장 잘 내가 말할 수있는 문제가 RST에서 해당 문자열 리터럴이 동일한 수준으로 들여 쓰기를 할 것으로 예상된다입니다.

해결 방법이 있습니까?

Answer 1

::을 들여 쓰고 사전을 들여 쓰면 코드 블럭으로 인식됩니다. 이것은 .. autofunction:: do_stuff과 스핑크스 1.5.2를 사용했습니다.

def do_stuff(foo, bar): 
    """Do some stuff 

    :param foo: I'm an argument 
    :param bar: So am I 

    :return: dict 
     :: 
      { 
       "success": (Boolean) True if stuff was done 
       "meta": { 
        "aaa": A nested return value 
        "bbb": Another nested return value 
       } 
      } 
    """ 

dict 부분을 분리했을 때 나는 그렇게 형식화해야했습니다.

def do_stuff(foo, bar): 
    """Do some stuff 

    :param foo: I'm an argument 
    :param bar: So am I 
    :rtype: dict 
    :return: 
     :: 

      { 
       "success": (Boolean) True if stuff was done 
       "meta": { 
        "aaa": A nested return value 
        "bbb": Another nested return value 
       } 
      } 
    """