2017-10-23 7 views
1

: Sphinx 스타일 문서화 문자열에 하이라이트 또는 코드 블록을 삽입하려면 어떻게해야합니까? 예를 들어

def foo(): 
    ''' 
    .. highlight:: python 
    import sys 
    ''' 

이 (가 그대로 단어 "하이라이트"를 인쇄하고 특별한 방법으로 다음 코드를 포맷하지 않음) 원하는 출력을 생성하지 않습니다. code-block에 대해서도 동일합니다.

다른 들여 쓰기 등을 시도해 보았습니다. 발전기는 대략 동일하지만 원하는 출력이 아니더라도 성공합니다.

+1

들여 쓰기가 없습니다. 가져 오기 라인 앞에 4 공간을 추가해보십시오. – Vinny

+0

@Vinny 분명히, 나는 두 개 사이에 빈 줄이 필요합니다! – wvxvw

답변

1

코드를 docs과 비교하면 들여 쓰기가 누락되고 강조 표시와 실제 코드 사이에 빈 줄이 생깁니다. 이것은 다음과 같아야합니다 :

def foo(): 
    ''' 
    .. highlight:: python 
    .. code-block:: python 

     import sys 
     ... 
    ''' 
+0

충분하지 않습니다. 코드는 리터럴 블록 (앞 단락이'::'으로 끝나는 블록)에 있어야합니다. – mzjn

+0

답변에 추가했습니다. 감사합니다. – Vinny

+0

편집 후에도 효과가 있지만 중복됩니다. '.. highlight :: python'을 제거 할 수 있습니다. – mzjn