目的

本記事では、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は以下の通り。

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

使用したDocker Imageはこちら。
これにより、HTML形式のドキュメントをgitlabからダウンロードすることができる。
以下の画像のアイコンからダウンロードしたいArtifactsを選択すればよい。