목적

이 기사에서는 gitlab-ci를 사용하여 gitlab에 Push 된 타이밍에서 Doxygen에 의한 API 문서를 출력하는 순서를 소개한다.
또한 Doxyfile을 생성하는 과정과 Doxyfile, Doxygen에 대한 설명은 생략한다.

절차

그럼, 샘플 코드를 사용해, Doxygen를 움직여 문서를 생성해 간다.
이번 샘플 프로젝트는 다음과 같은 디렉토리 배치가 되고 있다.
Doxyfile은 미리 준비해 둔다.

.
├── .gitlab-ci.yml #CIのジョブスクリプト
└── sample
    ├── Doxyfile #用意したDoxyfile
    └── sample.py #ドキュメント生成対象のサンプルソースコード

이번에는 sample.py에 대한 문서를 출력한다.
CI에서 실행되는 작업 스크립트 .gitlab-ci.yml는 다음과 같습니다.

.gitlab-ci.yml

image: hrektts/doxygen:latest

stages:
  - gen_document

Doxygen:
  stage: gen_document
  script:
    - cd sample
    - doxygen Doxyfile
  artifacts:
    name: "doxygen"
    expire_in: 1 week
    paths:
      - sample/html

사용한 도커 이미지는 여기
이렇게하면 HTML 형식의 문서를 gitlab에서 다운로드 할 수 있습니다.
아래 이미지의 아이콘에서 다운로드하고 싶은 Artifacts를 선택하면 된다.