2017-11-17 2 views
0

automodapi을 사용하여 장고 프로젝트 문서를 생성하려고합니다. 나는이 같은 automodapi 호출 할 때 :Automodapi 출력에서 ​​가져 오기를 제외하는 방법은 무엇입니까?

.. automodapi:: mypackage.mymodule 

출력 기능 및 클래스의 지수 예컨대 가져온 모든 클래스와 함수, 장고 모델 클래스가 포함되어 있습니다. 가져 오기를 제외하고 내가 지정한 모듈에서 선언 된 클래스와 함수 만 나열하고 싶습니다.

설명서에서이 내용을 볼 수 없습니다.

모듈을 수정하지 않고이 작업을 수행 할 수있는 방법이 있습니까?

업데이트 : @saimn은 __all__을 사용하는 작업 솔루션을 제공했지만 프로젝트는 __all__을 사용하지 않습니다. 모듈 수정과 관련없는 해결책이 있다면 좋을 것입니다.

답변

1

__all__ 변수를 사용할 수 있습니다 (설명서에 더 자세히 설명되어 있음).

+0

감사합니다. 클래스와 함수에 대해서는 작동하지만 변수에 대해서는 작동하지 않음을 확인할 수 있습니다 (필자가 언급 한 내용은': include-all-objects : '가 사용 된 경우입니다). – MarkG

+0

후속 조치 : 내 모듈은 현재'__all__'을 사용하지 않으므로 내 모듈을 수정하지 않고이를 수행하는 방법이 있다면 좋을 것입니다. ': allowed-package-names :'옵션을 시도했지만 설명대로 작동하지 않는 것 같습니다 (Sphinx 1.6.5, Automodapi 0.6) – MarkG

+0

사과, 내 첫 코멘트가 잘못되었습니다 -이 솔루션은 변수에서도 작동합니다. – MarkG

관련 문제