«autodoc» 태그된 질문

Sphinx를 사용하여 Python에서 5,000 라인 이상의 프로젝트를 문서화하려고합니다. 약 7 개의 기본 모듈이 있습니다. 내가 아는 한 autodoc을 사용하려면 프로젝트의 각 파일에 대해 다음과 같은 코드를 작성해야합니다. .. automodule:: mods.set.tests :members: :show-inheritance: 파일이 많기 때문에 너무 지루합니다. 'mods'패키지를 문서화하도록 지정하면 훨씬 쉬울 것입니다. 그러면 스핑크스는 재귀 적으로 패키지를 살펴보고 각 …

149 python  python-sphinx  autodoc 

Sphinx는 기본적으로 __init __ (self)에 대한 문서를 생성하지 않습니다. 나는 다음을 시도했다 : .. automodule:: mymodule :members: 과 ..autoclass:: MyClass :members: conf.py에서 다음을 설정하면 __init __ (self) docstring이 클래스 docstring에 추가됩니다 ( Sphinx autodoc 문서 는 이것이 예상되는 동작이라는 데 동의하는 것처럼 보이지만 해결하려는 문제에 대해서는 언급하지 않습니다). autoclass_content = …

107 python  python-sphinx  autodoc 

저는 스핑크스를 시작하려고 노력 중이며 끊임없는 문제가있는 것 같습니다. 명령: docs/sphinx-quickstart 나는 모든 질문에 답하고 모든 것이 잘 작동합니다. 명령: docs/ls 모든 것이 정상적으로 보입니다. 결과:build Makefile source 명령: sphinx-build -d build/doctrees source build/html 작동하는 것 같습니다. index.html 파일을 열고 원하는 "쉘"을 볼 수있었습니다. 실제 소스 코드를 source폴더 로 넣으려고하면 …

104 python  python-sphinx  autodoc 

저는 sphinx 와 autodoc 플러그인을 사용하여 Python 모듈에 대한 API 문서를 생성하고 있습니다. 특정 매개 변수를 잘 문서화하는 방법을 볼 수는 있지만 매개 변수를 문서화하는 방법의 예는 찾을 수 없습니다 **kwargs. 누구든지 이것을 문서화하는 명확한 방법에 대한 좋은 예가 있습니까?

99 python  python-sphinx  autodoc