Organize the doc directory by purpose

Closes #812 (closed)

概要

doc/ 直下に doxygen の入力・README 用画像・開発者向け解説文書が同居しており、ディレクトリ名から用途が判別できなかった。
用途ごとに doc/doxygen/ と doc/images/ へ分け、doc/ 直下には用途の異なるファイルを置かない構成にした。doc/CICD/ は既にディレクトリとして分離されているため変更していない。

issue では doc/Doxyfile.in の修正も必要としていたが、Doxyfile.in の PROJECT_LOGO と HTML_EXTRA_STYLESHEET はビルドディレクトリ側のパスを指すため、移動に伴う修正は不要だった。ビルドディレクトリ側の配置(doc/ に展開し doc/html へ出力する)は維持したので、.gitlab-ci.yml も変更していない。

あわせて、この整理の動作確認で判明した既存の不具合を修正した。doxygen のメインページでロゴが表示されず、公開ページで 404 になっていた(https://pages.frontistr.com/doxygen/doc/FrontISTR_logo.svg )。IMAGE_PATH が空のため、README の画像リンクがそのまま HTML に写り、画像の実体が出力に取り込まれていなかった。IMAGE_PATH に doc/images を指定して解決している。副作用として、doxygen が Markdown 画像の代替テキストを図のキャプションとして出力するため、ロゴの下に Logo の文字が表示される。README 側の代替テキストは残す判断とした。

変更前後で WITH_DOC=ON の文書生成を行い、生成物が一致することを確認した。doc/html 配下 30943 ファイルに差分はなく、警告もファイル別の件数まで一致する。ロゴ修正による差分は、画像1ファイルの追加とメインページの該当箇所だけである。

変更内容

コミット 要約
1371204b7accfad7f083a2a0c1cf4f2ddd68c5c3 Split doc/ into purpose-specific subdirectories doxygen の入力を doc/doxygen/ へ、README 用ロゴを doc/images/ へ移動し、CMakeLists.txt と README 2ファイルの参照を追随させた
7c2cf92a79355191fbd31d5e15b992ab1c913d59 Make the README logo resolve in the doxygen main page IMAGE_PATH に doc/images を指定し、メインページのロゴが生成物に取り込まれるようにした

Merge request reports

Loading
Loading