PDF 내보내기(PDF Export)

PDF 내보내기(PDF Export)

Ragas 공식 문서 전체를 하나의 PDF 파일로 만드는 기능이에요. MkDocs와 mkdocs-to-pdf 플러그인을 사용해 완성된 문서를 단일 PDF로 빌드해요.

출처: 문서

본문

목적(Purpose)

PDF 내보내기 기능은 mkdocs-to-pdf 플러그인을 사용해 MkDocs로 Ragas 문서 전체를 단일 PDF 파일로 빌드해요.

사용법(Usage)

구현은 두 개의 별도 MkDocs 설정을 사용해요:

  • mkdocs.yml – 표준 HTML 빌드용 (PDF 의존성 불필요)
  • mkdocs-pdf.yml – 메인 설정을 상속받고 PDF 플러그인을 추가

PDF 문서 빌드:

make build-docs-pdf

생성된 PDF는 site/pdf/document.pdf에서 볼 수 있어요. HTML 문서만 빌드:

make build-docs

make build-docs-pdf 명령은 빌드 전에 시스템 의존성을 자동으로 확인해요.

PDF의 Mermaid 다이어그램 (오프라인)

Mermaid 다이어그램은 PDF 빌드 중 오프라인으로 렌더링돼요(WeasyPrint가 실행되기 전에 SVG로 변환). 이를 위해 WeasyPrint 외에 몇 가지 추가 의존성이 필요해요.

필수 도구(Required tools)

  • Node.js (Mermaid 도구 실행에 필요)
  • @mermaid-js/mermaid-cli로 설치되는 Mermaid CLI (mmdc)
  • Puppeteer용 헤드리스 브라우저 (권장: chrome-headless-shell)

현재 제약 사항(Current Limitations)

시스템 의존성(System Dependencies): WeasyPrint는 별도로 설치해야 하는 OS별 시스템 라이브러리(Pango, Cairo)를 요구해요. 문제가 생기면 WeasyPrint 설정 안내와 문제 해결 가이드를 참고하세요.

ReadTheDocs: PDF 생성은 현재 ReadTheDocs 빌드 설정에서 활성화되어 있지 않아요.