pub_markdown_core.sh によるドキュメント発行処理において、プロジェクトルート直下に存在するサブモジュール内の mdRoot ディレクトリを、メインの mdRoot (デフォルト: docs-src) 配下にマージします。
サブモジュール構成を採用したプロジェクトでは、各サブモジュール (doxyfw, testfw, makefw 等) はそれぞれ独自の docs-src ディレクトリを持っています。
これらのドキュメントを統合的に発行するためには、サブモジュール内のドキュメントをメインプロジェクトの docs-src 配下にあるかのように扱う必要があります。
pub_markdown.config.yaml で対象サブモジュールを指定します。
mergeSubmoduleDocs: doxyfw makefw testfw docsfw| 設定値 | 動作 |
|---|---|
| 空または未指定 | 機能無効 |
| サブモジュール名リスト | 指定されたサブモジュールのみマージ対象 |
| 種類 | 実パス | 仮想パス |
|---|---|---|
| サブモジュールドキュメント | {submodule}/{mdRoot}/{path} |
{mdRoot}/{submodule}/{path} |
| メインドキュメント | {mdRoot}/{path} |
{mdRoot}/{path} |
| ステップ | makefw の例 | testfw の例 |
|---|---|---|
| 実パス | makefw/docs-src/make-local.md |
testfw/docs-src/how-to-mock.md |
| 仮想パス | docs-src/makefw/make-local.md |
docs-src/testfw/how-to-mock.md |
| mdRoot からの相対 | makefw/make-local.md |
testfw/how-to-mock.md |
| HTML 出力 | docs/ja/html/makefw/make-local.html |
docs/ja/html/testfw/how-to-mock.html |
mergeSubmoduleDocs が指定されている場合、relativeFile に以下のパス形式を受け入れます。
| パス形式 | 例 | 動作 |
|---|---|---|
| メイン mdRoot パス | docs-src/build-design.md |
従来通り処理 |
| 実パス(主) | makefw/docs-src/make-local.md |
実パスを内部で仮想パスに変換して処理 |
| 仮想パス(拡張) | docs-src/makefw/make-local.md |
仮想パスを実パスに変換して処理 |
| 指定パス | 処理対象 |
|---|---|
docs-src |
メイン mdRoot + 指定サブモジュールの mdRoot |
docs-src/makefw |
makefw サブモジュールの mdRoot 配下のみ |
makefw/docs-src |
makefw サブモジュールの mdRoot 配下のみ (実パス指定) |
\toc コマンドによる目次生成時、指定サブモジュールのドキュメントも含まれます。
目次リンクの生成例:
- 📁 [makefw](makefw/index.md)
- 📄 [make-local.md](makefw/make-local.md)
- 📄 [template-auto-selection.md](makefw/template-auto-selection.md)サブモジュール内のサブモジュールも処理可能です。
mergeSubmoduleDocs: doxyfw makefw testfw testfw/gtestこの場合のパス変換:
| 実パス | 仮想パス | HTML 出力 |
|---|---|---|
testfw/gtest/docs-src/MANUAL_BUILD.md |
docs-src/testfw/gtest/MANUAL_BUILD.md |
docs/ja/html/testfw/gtest/MANUAL_BUILD.html |
mdRoot 配下に同名のディレクトリが存在する場合は、メイン側を優先します。