はじめに
今回ほぼPythonは関係なくなっちゃいましたが
一応前回の続きです。
今回は、MarkDown記法を使ってMainPageとDocumentation Pageを作成します。
Doxygenで使えるMarkDownについて
Doxygenでは、MarkDownが全て使えるわけではなく以下のページに定義されているものしか使えないようです。
Mainpageについて
まず、Doxygenで作成されたindex.htmlを開いたときのトップページを作成します。
Doxygenで読みに行くフォルダにReadme.mdという名前でMarkdownファイルを作成します。
(実際ファイル名はなんでもいいのですがトップページなのでやはりReadmeかなと思います。）
このファイルの一番上に
# @mainpage ここはTopPageだよ {#mainpage}
と見出しを書くことで自動的にトップページとして認識されます。
前回の記事を参考にDoxywizardからRunしてビルドするとトップページがReadme.mdになっているはずです。
Documentation Page について
こちらは、Doxygenの上部タブ「Related pages」から飛べる各種ドキュメンテーションのことです。
関連資料だったり、諸々の説明ページを保存することができます。
これもmarkdownで追加することができます。
今回はDocumentation Pageの例としてSampe.mdを作成してみます。
Readme.mdと同じように、Doxygenで読みに行くフォルダのどこか適当な場所に
Sample.md という名称のファイルを追加します。
ビルドすると、Doxygenの「Related Pages」には追加されます。
Documentation Page へのリンクを作成する
このままですと Sampe.mdは、Related Pagesからしかアクセスできないので
リンクを作成します。
まず、Sample.mdを他のページから識別するために、識別用のリンクを与えます。
Sample.mdの一番上に以下を追加します。
# なんか見出し {#Sample}
ここの{}で囲まれているところが識別子になります。
次に、試しにReadme.md側のどこかに
[リンクしたい文字列](@ref Sample)
と書くと、自動的にリンクが生成されます。
@ref のところに識別子を書くことで、その識別子のあるページにリンクが張られるという仕組みのようです。便利
画像をはる
おまけ
画像もはることができます。
一応、画像リソースの準備として、Doxygenで作成されるhtmlフォルダ以下のどこかに画像をおかないといけません。
今回は例として、htmlフォルダにimagesフォルダがあり、そこにsample.jpgがあると仮定します。
そして、Sample.mdファイルに以下のように書き込みます。
すると、画像が表示されるはずです。
