travis-sphinx에서 Github Pages에 Sphinx 문서 게시

개요

travis-sphinx 을 이용해 보았으므로, 그 때의 순서를 기사로서 남겨 둡니다.
travis-sphinx는 Github의 Sphinx 문서를 Travis CI에서 빌드하고 gh-pages 분기에 Push 할 때까지 자동화하는 도구입니다.

이용 방법에 대해서는 희귀 D 째. MD 를 참고로 하고 있습니다.

전제

이번은 이하의 버젼으로 동작 확인하고 있습니다.


도구
버전


파이썬
3.5.1

스핑크스
1.4.1

gh-pages 브랜치 만들기

먼저 Github Pages에 대한 분기를 만듭니다.

    git checkout -b gh-pages
    git rm -rf .
    git push --set-upstream origin gh-pages

게다가 gh-pages 브랜치에 미리 .nojekyll 파일을 작성해, push 해 둡니다.

Github 액세스 토큰 얻기

travis-sphinx는 gh-pages 분기에 문서를 푸시하기 위해 액세스 토큰이 필요합니다.
아래 Github 계정의 Personal Settings 메뉴에서 설정을 구성합니다.



Personal Settings > Personal access tokens 메뉴를 열고 "Generate new token"에서 액세스 토큰을 얻습니다.
액세스 토큰의 scopes는 public_repo를 선택해 두면 문제가 없었습니다.



Travis CI 측 프로젝트의 설정에서 환경 변수에 GH_TOKEN을 만들고 Github에서 얻은 액세스 토큰을 설정합니다.

.travis.yml 만들기

이번에는 다음과 같은 python3.5 환경에서 빌드하는 .trais.yml를 만들고 시도했습니다.
스크립트에서는, travis-sphinx build (와)과 travis-sphinx deploy (을)를 호출해 두면, 문서의 빌드와 Push 를 실시해 주는 것 같습니다.

language: python
python:
    - "3.5"

before_install:
    - wget http://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh
    - chmod +x miniconda.sh
    - "./miniconda.sh -b"
    - export PATH=/home/travis/miniconda2/bin:$PATH
    - conda update --yes conda
    - sudo rm -rf /dev/shm
    - sudo ln -s /run/shm /dev/shm

install:
    - conda install --yes python="3.5" sphinx
    - pip install --user travis-sphinx

script:
    - travis-sphinx build --source=example build

after_success:
    - travis-sphinx deploy

결론

travis-sphinx 의 README.md를 읽으면, 특히 지루하게 이용하기 시작할 수 있다고 생각합니다만, 매우 간단하게 Github Pages에의 공개까지 자동화할 수 있어 감동했기 때문에 사용법을 정리했습니다.

덧붙여서, 최근 Sphinx에 중독되어 테마를 만들 때 travis-sphinx를 이용하여 Github Pages에 데모 문서를 공개해 보았습니다.
그래서 이쪽의 테마도 잘 부탁드립니다.
ㅡㅡㅡㅜㅜㅜㅜㅜ 기주 b. 이오 / sp 힌트 x 보오 tst et al p4 tee /