이 문서 관리하기¶
Guidedog 프로젝트는 docs/manual, docs/api, docs/gds 세 개다. 설명서와 GDS는 guidedog quickstart로 시작했다. 생성된 템플릿을 직접 수정한다. 설계 기록을 설명서 목차에 넣지 않는다.
설명서 빌드¶
저장소 루트에서 실행하세요.
build/guidedog build html docs/manual -j auto -W
build/guidedog build pdf docs/manual -W
build/guidedog serve docs/manual
설명서 목차에는 전체 Odin API 참고서가 포함된다. PDF 명령은 설명과 선언을 링크로 연결한 한 권의 책을 만든다. 설명서와 별도 API 프로젝트는 모두 lib/에서 참고서를 생성하므로 복사한 API 원고를 동기화할 필요가 없다.
API 프로젝트만 빌드하려면 다음을 실행하세요.
build/guidedog build html docs/api -W
build/guidedog build pdf docs/api -W
논의 문서 빌드와 검사¶
build/guidedog gds index
build/guidedog gds check
build/guidedog gds build --target=both
GDS CLI는 메타데이터, 번호, 상태, 복구를 관리한다. RST 게시 경로는 프로젝트 엔진을 호출해 전체 HTML 사이트와 기록별 PDF를 만든다. 선택자는 PDF만 제한한다. HTML은 전체 목록을 갖춘 일관된 사이트로 남는다. 선택한 PDF 미리보기는 _build/selected/<artifact>/pdf를 쓰며 _build/pdf의 전체 목록은 유지한다.
build/guidedog gds build guidedoc-odin --target=pdf
build/guidedog build html docs/gds -W
build/guidedog build pdf docs/gds -W
일반 프로젝트 명령도 사용할 수 있다. GDS 프로젝트는 자체 conf.toml과 _build 폴더를 쓴다. 작성 절차는 docs/gds/workflow.rst를 읽는다.
게시하기 전에¶
링크와 진단, 넓은 표와 코드 블록을 확인한다. 타이포그래피를 바꾸면 PDF 페이지를 렌더링해 살핀다. HTML은 데스크톱·휴대폰 너비와 밝은·어두운 모드에서 테스트한다. 수식과 그림이 오프라인에서도 작동하는지 확인한다. 엔진을 수정하면 관련 라이브러리와 통합 테스트를 실행한다.