Skip to content

Sphinx pdf #

Find similar titles

5회 업데이트 됨.

Edit
  • 최초 작성자
    Duskan
  • 최근 업데이트
    lca

Sphinx로 작성한 도움말을 Latex 를 이용하여 pdf 형태로 출력하기 #

Sphinx에서는 HTML 을 이용하여 도움말 페이지를 작성할 수 있을 뿐만 아니라 pdf 등 다양한 폼으로 도움말을 출력할 수 있다.

이 중 가장 범용적으로 사용 가능한 pdf 파일의 경우 한번에 생성되는것이 아니라 pdf를 만들 수 있는 Latex 프로젝트 파일이 생성되므로, Sphinx로 PDF문서를 만들려면 설정작업이 필요하다.

환경 설정 #

Latex를 사용하기 위해서는 TexLive를 설치해야한다. 현재(2015.12) 기준으로 나온 최신 버전은 TexLIVE 2015 가 있으며 이전 버전으로 사용하더라도 무방하다. 다만 이전 버전으로 사용할 경우 TexLive에서 한국어 패키이지인 Kotex 패키지를 지원하지않으므로 따로 버전에 맞는 패키지를 설치 한 후 사용해야 한다.

TexLive 설치 방법 #

  • Mac OS X 이상 설치 방법 : 인터넷에서 MacTex 2015 설치 후 아래 명령어로 최신 업데이트 실행

$ sudo tlmgr update --all --self

PDF 생성 방법 #

  1. Sphinx 문서의 Makefile이 있는 곳에서 make latex 실행
  2. build/latex 에서 "프로젝트명.tex" 파일 맨 상단에서 에서 다음부분 수정
  3. \usepackage[T1]{fontenc} 를 다음과 같이 바꾸어야 한다. \usepackage{kotex}한글 폰트 사용 (영문만 사용할 경우 필요 X)
  4. \usepackage{babel} -> \usepackage[english]{babel} (# babel기본 언어 설정 ,설정 안할시 오류발생)
  5. build/latex 에서 make

파일을 그대로 make할 경우 한글이 제대로 보이지 않거나 에러가 발생할 수 있다. 그러므로 make latex 를 한 후 3,4 와 같이 수정해야 정상적으로 파일을 확인 할 수 있다.

주의 사항 #

  1. Sphinx의 경우 한글을 따로 지원하지 않으므로 language=ko로 설정하더라도 한글을 출력하지 않는다. PDF 생성방법 - 3,4 번에서처럼 한글 설정을 위해서는 내부 파일을 바꿔야 한다.
  2. Sphinx에서 코드블럭에 코드를 입력할 때 페이지 길이보다 많은 글자를 입력할 경우 글자가 페이지를 넘어가는 버그가 있다. 해당 문제는 Sphinx에서 Latex생성과정에서 발생되는 문제로 Latex파일을 직접 수정하더라도 원하는 결과는 보기 어렵다 (HTML에서는 잘됨) 만약 Sphinx에서 코드블럭을 작성할 경우 작성자가 줄을 미리 잘 나눠야 PDF로 만들기 쉽다.

Suggested Pages #

0.0.1_20240318_1_v95