스핑크스 자동 서문 지시문에서 "생성 된"옵션은 무엇입니까?

Question

나는 도서관에 대한 API를 문서화하는 스핑크스 API-문서 및 autosummary 확장을 사용하고 있는데 나는 아래 generated/ 옵션의 목적을 이해하기 정말 드릴 수 없습니다 : 이것은이다 내가 본

.. autosummary:: 
    :nosignatures: 
    :toctree: generated/ 

    module.function_1 
    module.function_2 
    ... 

을 스핑크스 문서 및 판다와 같은 도서관에서 볼 수 있습니다. 나는 toctree를 사용하고 API는 자동 생성되지만 생성 된 내용을 이해하지 못합니다. 생성 된 폴더가 표시되지 않으며이 폴더의 이점/목적이 무엇인지 알 수 없습니다.

감사

Answer 1

은 "생성"옵션은 스핑크스가 자동으로 "그루터기"한 .rst 파일을 생성두고 출력 디렉토리의 이름입니다. "생성 된"이라고 불릴 필요는 없습니다. 어떤 이름이라도 사용할 수 있습니다.

autosummary_generate 구성 변수가 True으로 설정되면 Sphinx는 autosummary 지시문에 나열된 각 항목에 대해 .rst 파일을 생성합니다. 예를 들어 여러 클래스가있는 모듈을 문서화하는 경우이 기능을 사용하여 각 클래스의 전체 설명서를 별도의 페이지에 넣을 수 있습니다. 자동 요약 테이블에는이 페이지에 대한 링크가 포함됩니다.