reStructuredText 링크

Question

는

:

def _add_parameter(self, a): 
    # do something 

을 내가 reStructuredText를 사용하여 위의 함수에 연결하는 문서화 문자열을 추가하려면, 난 그냥 말에 밑줄을 추가 할 필요가 다음과 같은 함수 이름 :

""" 
The _add_parameter_ adds parameters. 
""" 

는 그러나 대신 함수에 연결에, 나는 cannot find declaration to go to 경고를 얻을. 이 문제를 어떻게 해결할 수 있습니까?

Answer 1

autodoc 확장은 비공개 멤버, 즉 이름이 밑줄로 시작하지 않는 멤버 만 문서화합니다. 문서에서 :

.. autoclass:: Noodle 
     :members: 
    will document all non-private member functions and properties (that is, 
    those whose name doesn’t start with _). 

이렇게하면 autodoc이 연결할 장소를 찾으려고 시도 할 때 찾지 못합니다.

비공개 회원을 문서화하지 않고 무시하려면 :private-members:을 사용할 수 있지만 정상적으로 작동하는지는 알 수 없습니다. 그러나 일반적으로 공용 인터페이스 만 문서화하는 것이 좋습니다.