2017-10-03 1 views
-1

내 문서 문자열을 멋진 문서 페이지로 변환 할 때 sphinx autodoc을 사용하고 있습니다. docstring에서 나는 sphinx napoleon 확장을 사용하여 numpy의 문서화 지침을 따른다. 나는 다음에 대해 궁금 해요 : 나는 :label:를 인식하지 못하는python docstring의 레이블

""" 
This is a very important equation which is used in the code 

.. math:: 

    a+b=c 
    :label: important_eq 
""" 

autodoc 같은 수식이있는 경우. 형식이 잘못되었거나 방정식의 레이블을 autodoc/mathjax/napoleon이 처리 할 수 ​​없습니까?

답변

1

공백과 들여 쓰기에주의하십시오. 이 작품 :

.. math:: 
    :label: important_eq 

    a+b=c 

이 너무 작동 (수학 내용의 텍스트가 한 줄 때, 그것이 지시 인자로 주어질 수있다) :

.. math:: a+b=c 
    :label: important_eq 
관련 문제