파이썬 패키지 문서화에 NumPyDoc 스타일 docstrings을 사용하고 있습니다. 'numpydoc' 스핑크스 확장을 Napoleon으로 바꾸고 싶습니다. 더 작고 읽기 쉬운 방법으로 문서화 문자열을 포맷합니다. 그러나 numpydoc의 매우 귀중한 기능을 발견 한 문서 상단에 클래스의 메서드가 나열되어 있지 않습니다. 사람이 나폴레옹 수동으로 전환하
numpy docstring 지침에 따라 문서화 문자열을 작성하고 있습니다. 그런 다음 sphinx의 autodoc을 사용하여 내 문서를 생성합니다. 어떤 문서 문자열에서는 LaTeX 수식 (sphinx.ext.mathjax)을 사용하고 있습니다. \r은 새로운 라인과 같은 특별한 것을 의미합니다. 다음 명령을 사용하는 경우 : """
This :math
내 문서 문자열을 멋진 문서 페이지로 변환 할 때 sphinx autodoc을 사용하고 있습니다. docstring에서 나는 sphinx napoleon 확장을 사용하여 numpy의 문서화 지침을 따른다. 나는 다음에 대해 궁금 해요 : 나는 :label:를 인식하지 못하는 """
This is a very important equation which i
Sphinx 확장 프로그램 NumpyDoc을 사용하면 문서가 문서화 한 코드와 자동으로 일치하는지 확인할 수 있습니까? 예를 들어, 다음과 같은 문서에 의한 오타에 코드를 일치하지 않습니다 def myfunc(apples, bears):
"""
Parameters
----------
apples : int
The nu
Numpy 문서가 필요한 프로젝트를 진행하고 있습니다. Java 시절에 Eclipse/IDEA에서 Javadoc 준수 여부를 확인한 linters가 있다는 것을 기억합니다. Numpy 문서 스타일 준수 여부를 확인하는 것과 동일한 기능이 있습니까? 나는 PEP257에 대해 알고 있지만, Numpy 문서에 대한 구체적인 검사가없는 것 같습니다.