GitHub Pages は、GitHub リポジトリのコンテンツを静的な Web サイトとして公開するサービスです。無料で利用でき、https://<ユーザー名>.github.io/<リポジトリ名>/ の URL でアクセスできます。HTML・CSS・JavaScript などの静的ファイルをホストでき、ドキュメントサイトの公開に広く使われています。
このリポジトリは GitHub Actions と連携して、ドキュメント生成 (Doxygen → Doxybook2 → Pandoc) の成果物を自動的に GitHub Pages に公開しています。C ソースコードの API ドキュメントや設計ドキュメントが Web から参照できるようになります。デプロイには peaceiris/actions-gh-pages Action を使用しています。
GitHub Pages へのデプロイを理解することで、ドキュメントの公開状態を確認し、公開設定のトラブルシューティングができるようになります。
デプロイの流れ:
1. GitHub Actions がトリガー (main ブランチへのプッシュ)
2. make docs でドキュメントを生成
3. docs/ ディレクトリの内容を gh-pages ブランチにプッシュ
4. GitHub Pages が gh-pages ブランチを公開ワークフローでのデプロイステップ例:
- name: GitHub Pages にデプロイ
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs
publish_branch: gh-pages公開されるドキュメントの構成:
docs/
+-- doxygen/ # Doxygen 生成の HTML (直接参照用)
+-- ja/html/ # 日本語版 HTML ドキュメント
+-- en/html/ # 英語版 HTML ドキュメントGitHub リポジトリの Pages 設定確認:
- リポジトリ → Settings → Pages → Source: Deploy from a branch・Branch: gh-pages