# バッチ設計書 14-manpage.py

## 概要

本ドキュメントは、libuvプロジェクトのSphinxカスタムロールプラグイン（`docs/src/sphinx-plugins/manpage.py`）のバッチ設計書である。reStructuredTextドキュメント内で `:man:` ロールを使用してman(1)形式の参照リンクを自動生成する機能を提供する。

### 本バッチの処理概要

manpage.pyは、Sphinxのカスタムロール拡張として機能し、rstドキュメント中に記述された `:man:` ロール（例: `:man:`getaddrinfo(3)``）を、対応するmanページへのHTMLハイパーリンクに変換するプラグインである。

**業務上の目的・背景**：libuvはPOSIXシステムコールやLinuxカーネルAPIと密接に関連するライブラリであり、APIドキュメント中でシステムのmanページを参照する場面が多い。ドキュメント執筆者がmanページへのリンクを簡潔に記述でき、かつリンク先URLの一元管理を可能にするために本プラグインが開発された。sphinxcontrib-manpageをベースに改変されたものである。

**バッチの実行タイミング**：sphinx-buildによるドキュメントビルド時に自動的にロードされる。conf.pyの `extensions = ['manpage']` 設定およびsys.pathへのプラグインディレクトリ追加により、Sphinxが起動時にsetup()関数を呼び出す。

**主要な処理内容**：
1. Sphinxアプリケーションに `:man:` カスタムロールを登録
2. `man_url_regex` 設定値の登録（カスタムURL生成用）
3. rstドキュメント中の `:man:` ロール記法を正規表現でパースし、コマンド名とセクション番号を抽出
4. man7.org のmanページURL（またはカスタムURL）へのHTMLリンクノードを生成

**前後の処理との関連**：本プラグインは `docs/src/conf.py`（No.13）の `extensions` 設定により読み込まれる。ドキュメントビルド全体（No.12 docs/Makefile）の一部として動作する。

**影響範囲**：rstドキュメント中の `:man:` ロールを使用している全ページのHTML出力に影響する。man_url_regexが未設定の場合はman7.orgへのリンクが生成される。

## バッチ種別

ドキュメント生成（Sphinxプラグイン・テキスト変換処理）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | sphinx-buildの実行ごと |
| 実行時刻 | sphinx-build実行時 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | Sphinxエンジンによるプラグイン自動読み込み |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| conf.pyでextensions登録 | `extensions = ['manpage']` がconf.pyに定義されていること |
| sys.pathにプラグインパス追加 | conf.pyで `sys.path.insert(0, os.path.abspath('sphinx-plugins'))` が実行されていること |
| docutils | docutilsパッケージ（nodes, utils, parsers.rst.roles）が利用可能であること |
| string.Template | Python標準ライブラリのstring.Templateが利用可能であること |

### 実行可否判定

Sphinxがconf.pyの `extensions` リストを読み込み、`manpage` モジュールの `setup()` 関数を呼び出すことで自動的にプラグインが有効化される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| man_url_regex | string | No | None | カスタムmanページURLテンプレート（`$num`, `$topic` プレースホルダ使用）。未設定時はman7.orgのURLが使用される |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| rstドキュメント中の `:man:` ロール | reStructuredText | 例: `:man:`getaddrinfo(3)`` |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| docutilsノードツリー | nodes.reference | Sphinxが処理するドキュメントノードとしてHTMLリンクを生成 |

### 出力ファイル仕様

manpage.pyは直接ファイルを出力しない。docutilsのノードツリーにリンクノードを追加し、Sphinxが最終的なHTML等の出力を行う。

| 項目 | 内容 |
|-----|------|
| リンクテキスト | `{コマンド名}({セクション番号})` 例: `getaddrinfo(3)` |
| リンク先URL（デフォルト） | `https://man7.org/linux/man-pages/man{n}/{name}.{n}.html` |
| リンク先URL（カスタム） | `man_url_regex` テンプレートによる生成 |

## 処理フロー

### 処理シーケンス

```
1. Sphinxがsetup(app)を呼び出し
   └─ app.add_role('man', man_role) でカスタムロール登録
   └─ app.add_config_value('man_url_regex', None, 'env') で設定値登録
2. rstパース時にman_role()が呼び出される
   └─ 正規表現 ([a-zA-Z0-9_.-_]+)\((\d)\) でテキストをパース
   └─ グループ1: コマンド名、グループ2: セクション番号
3. make_link_node()でリンクノード生成
   └─ man_url_regexが未設定: man7.orgデフォルトURLを使用
   └─ man_url_regexが設定済: string.Templateで$num, $topicを置換
4. nodes.reference()でdocutilsリンクノードを返却
```

### フローチャート

```mermaid
flowchart TD
    A[Sphinxがsetup呼び出し] --> B[man ロール登録]
    B --> C[man_url_regex設定値登録]
    C --> D[rstパース中にman:ロール検出]
    D --> E[man_role関数呼び出し]
    E --> F[正規表現でコマンド名とセクション番号を抽出]
    F --> G{man_url_regex設定あり?}
    G -->|No| H[man7.orgデフォルトURL生成]
    G -->|Yes| I[string.Templateでカスタム URL生成]
    H --> J[nodes.referenceリンクノード生成]
    I --> J
    J --> K[ノードツリーに追加]
```

## データベース操作仕様

### 操作別データベース影響一覧

本バッチはデータベースを使用しない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 該当なし | - | - | - |

### テーブル別操作詳細

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| AttributeError | パースエラー | `:man:` ロールのテキストが正規表現パターンに一致しない | rstドキュメント中のman参照記法を修正（例: `name(N)` 形式にする） |
| ImportError | モジュールエラー | docutilsが未インストール | pip install docutils でインストール |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回 |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

1. `:man:` ロールのパースエラー：正規表現 `([a-zA-Z0-9_.-_]+)\((\d)\)` に一致しない入力がある場合、`m.group()` でAttributeErrorが発生する。rstドキュメントのman参照記法を `name(N)` 形式に修正する。
2. manページURLが404の場合：デフォルトのman7.orgリンクが対象manページを提供していない場合は、`man_url_regex` 設定でカスタムURLを指定する。

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | ドキュメント中の `:man:` ロール出現回数に依存 |
| 目標処理時間 | 即時（各ロール変換はマイクロ秒単位） |
| メモリ使用量上限 | 無視できる程度 |

## 排他制御

Sphinxビルドプロセスはシングルスレッドで実行されるため、排他制御は不要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 該当なし | プラグイン自体はログを出力しない |
| 進捗ログ | 該当なし | プラグイン自体はログを出力しない |
| 終了ログ | 該当なし | プラグイン自体はログを出力しない |
| エラーログ | パースエラー時 | Sphinxのビルドエラーとして出力される |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ビルドエラー | manロール解析失敗時 | Sphinxビルドログ |

## 備考

- 本プラグインはDariusz Dwornikowski氏のsphinxcontrib-manpage（Apache 2ライセンス）を元に改変されたものである
- デフォルトのリンク先はman7.org（`https://man7.org/linux/man-pages/man{n}/{name}.{n}.html`）である
- セクション番号は1桁の数字（`\d`）のみ対応しており、2桁以上のセクション番号には非対応
- 正規表現パターン中に `_.-_` という記述があるが、文字クラス内のハイフン位置により意図と異なる動作をする可能性がある（潜在的なバグ）
