4. 全文検索エンジンの利用¶
- ドキュメント内の全文検索を利用する場合次のセットアップが必要です。
4.1. node セットアップ¶
インストーラをダウンロードします。
Sphinxをビルドする実行環境に合わせたインストーラをダウンロードします。インストーラを起動しセットアップを行います。
4.2. oktavia セットアップ¶
インストーラをダウンロードします。
任意のディレクトリに展開します。
コラム
例:C:\oktavia
4.3. Sphinx ドキュメントへの適用¶
ビルドを実行するSphinxドキュメントの実行ファイルを編集します。
任意のディレクトリに配置したSphinxソースのプロジェクト直下にある、 make.bat ファイルをテキストエディタで開きます。
コラム
例:intra-mart Accel Platform 一般ユーザガイドC:\user_guide\make.bat L.51とL.52の間(下図の点線)に次のコマンドを追加します。node %oktaviaを展開したディレクトリパス%/bin/oktavia-mkindex-cli -i build/html -r build/html -m html -u file -f .content -c 5 -t web -o build/html/searchindex.js -I
4.5. 全文検索エンジンを利用しない場合¶
- 全文検索(クリック検索)の部品を外す事ができます。
レイアウトファイルを編集します。
%Sphinxドキュメントディレクトリ%/source/common_all/amy/layout.html をテキストエディタで開きます。
コラム
例:intra-mart Accel Platform 一般ユーザガイドC:\user_guide\source\common_all\amy\layout.htmlL.96-L.98の3行をコメントアウトします。
ビルドを行います。コラム
ビルド方法は、「 動作確認 」を参照してください。html版のドキュメントをブラウザ上で確認できます。