예를 들어, Python의 내부 기반 모드 enumerate()를 문서화하는 데 도움이 되도록 소스 파일의 항목에 추가할 수 있습니다. 이제 특정 파일을 추가했고 블로그를 작성하게 Booi 아이폰 앱 되었으므로 문서에서 초기 빌드를 구축해 보겠습니다. 추가할 문서는 파일 이름 때문에 제공됩니다. 간단히 말해서 파일 레이블 확장에서 벗어나 디렉토리 구분 기호 때문에 제출 슬래시(/)를 사용한다는 의미입니다. 이는 여러 문서를 파일 중 하나의 계층 구조로 연결하는 수단인 reStructuredText를 Sphinx가 늘리는 항목 중 하나일 수 있습니다. conf.py가 있는 훌륭한 소스 디렉토리를 구성했으며 루트 파일인 index.rst를 만들 수도 있습니다.
빌더¶
PyPI의 설치 패키지를 보유하는 가장 인기 있는 단위는 pip이며, 이는 모든 최신 Python 모델에 포함되어 있습니다. 그러면 새로운 스핑크스 변동 금액이 인쇄됩니다. 그러나 conf.py는 새로운 구성 목록인 다른 디렉터리에 있을 수 있습니다. Sphinx.ext.intersphinx는 intersphinx 속성의 전체 오작동을 나타냅니다.
따라서 intersphinx를 조작할 수 있으므로 확장 목록에 대한 새로운 시퀀스 ‘sphinx.ext.intersphinx’를 입력하여 conf.py 내에서 이를 활성화하고 실제로 가치가 있는 intersphinx_mapping 구성을 배치해야 합니다. Sphinx는 autodoc이라는 확장(확장은 Sphinx 프로젝트에 추가 기능을 제공하는 훌륭한 Python 모듈임)이 있는 세그먼트에서 최신 독스트링 도입을 돕습니다. 최신 파일은 첫 번째 줄의 인코딩 선언으로 표현된 것처럼 기본적으로 UTF-8 내에서 보호됩니다. 최신 문서에서는 체인, 수량, 목록 등에 대한 Python 구문을 사용한다는 점을 기억하십시오. sphinx-quickstart에 의해 자동으로 추가되지 않는 훌륭한 구성을 사용자 정의하려면 추가 작업을 생성하기만 하면 됩니다. 제공된 모든 도메인 이름과 해당 지시어/위치에 대한 도메인입니다.
첫 번째 설정¶
이는 빌더의 레이블에서 생성을 실행하여 수행할 수 있습니다. (필요한 경우 깊이 중첩된 계층을 만들 수 있도록 자체적으로 트리 지시문을 통합할 수 있습니다.) 또한 Sphinx는 이제 구매에 대해 알고 있으며 사용자는 데이터의 단계를 수행할 것입니다. 이것이 파일로 인한 toctree의 모습입니다. 각 지시문은 기사로 허용할지 여부를 설정하며 어떤 방향으로 진행할 것인지 결정합니다.
콘다 패키지¶
이 작업은 여기에서 make the-pdf를 통해 수행할 수 있습니다. 두 작업을 결합하려면 sphinx-generate -M(i.age. -M latexpdf가 -b latexpdf가 아닐 수도 있음)을 사용하거나 패널 옵션에서 latexpdf를 생성하세요. It 빌더는 독립형 HTML 빌더와 동일한 제작물을 제공하지만 전자책 구독자를 선언하는 epub도 생성합니다. 작성자는 독립형 HTML 작성자와 동일한 출력을 생성할 뿐만 아니라 새로운 GNOME Devhelp 사용자가 자신에게 액세스할 수 있도록 하는 GNOME Devhelp 지원 파일도 만듭니다.
Toctree는 매우 다재다능한 마크업인 탁월한 reStructuredText 지시어입니다. So it 문서의 목표는 Sphinx가 실제로 무엇인지, 그리고 어떻게 사용할 수 있는지 간단하게 소개하는 것입니다.
공급 부족 설정¶
다른 피클 문서 대신 피클 문서를 사용하려면 피클 해제에 사용할 수 있는 새로운 스핑크스 패키지가 필요합니다. 이는 일반적으로 빌더와 독립적인 훌륭한 피클 파일이며 빌더가 시작될 때 사용된 환경의 복사본일 수 있습니다. _provide 아래에는 자신의 리소스 문서 이름이 표시됩니다.
코드에 대한 locale_dirs가 있는 이러한 유형의 파일을 검색 가능하게 만들면 Sphinx는 자동으로 해당 파일을 선택합니다. Sphinx는 sphinx-generate -M gettext 호출을 통해 이를 추출합니다. 코스 내부의 텍스트를 번역된 문자열에 순진하게 매핑합니다. Sphinx는 이러한 유형의 비즈니스를 사용하므로 전체 데이터 파일을 변경할 수 있습니다. 탐색 펍과 같이 Sphinx에서 생성한 메시지로 전송된 번역을 돕기 위해 Sphinx는 문서의 새로운 번역을 지원하는 요소를 제공합니다. 새로운 문서를 검색하는 데 사용할 수 있는 디렉토리입니다.
직렬화 생성자 정보¶
Sphinx HTML 레코드를 호스팅할 수 있도록 자신만의 온라인 시스템을 사용할 수 있습니다. 간단한 사실은 이 솔루션이 훨씬 더 많은 독립성과 훨씬 더 복잡함을 제공한다는 것입니다. Investigate Docs는 실제로 Sphinx 및 MkDocs로 작성된 기술 문서 호스팅에 중점을 둔 온라인 솔루션입니다. Sphinx(마스터) 서류 작업을 위한 훌륭한 Sphinx 해석 페이지를 찾을 수 있습니다.