Guidedog / 문서
0.2.0
문서 빌드와 게시¶
프로젝트의 기본 출력 디렉터리로 빌드하세요.
guidedog build html docs/manual -j auto -W
guidedog build pdf docs/manual -W
사이트는 docs/manual/_build/html에 있다. PDF와 생성된 Typst 소스는 docs/manual/_build/pdf에 있다. 웹 서버가 HTML 폴더를 정적 파일로 제공할 수 있으므로 운영 환경에 Odin 서버가 필요하지 않다.
출력 디렉터리 선택¶
Sphinx 방식은 소스와 출력 경로를 명시합니다.
guidedog build -b html docs/manual build/manual-site -W
출력은 소스 밖에 둔다. 게시가 소스 트리를 대체하는 구조는 Guidedog이 거부한다. 사용자 지정 대상은 build/.manual-site.guidedog/.doctrees 같은 안정적인 형제 캐시를 사용하므로 게시 폴더에는 게시물만 들어간다.
미리 보기와 검사¶
guidedog serve docs/manual
guidedog build dummy docs/manual -n -W
dummy 빌더는 프로젝트를 읽고 관계를 해결하지만 게시물을 만들지 않는다. 빠른 의미 검사에 사용한다. 최종 페이지 레이아웃은 검사하지 않는다.
재현 가능한 시각¶
SOURCE_DATE_EPOCH=1790812800 guidedog build html docs/manual -W
이렇게 빌드 시간을 고정한다. 재현성은 소스, 템플릿, 글꼴, 컴파일러 버전, 리소스에도 달려 있다. 시계만 고정해서는 부족하다.
빌드가 성공한 뒤 전체 폴더를 게시한다. 정상 종료는 필요조건이다. 템플릿을 바꾼 뒤에는 시각적 확인도 필요하다.