応募トーク

これは応募されたトークです。聞きたいと思うトークをSNSで拡散しましょう。選考時に参考にさせていただきます。

talk

Sphinxで作成したドキュメントをDashに取り込む方法(ja)

スピーカー

togakushi

対象レベル:

初級

カテゴリ:

Documentation

説明

HTMLで作成されたドキュメントを取り込み、キーワードをローカルでインクリメンタルサーチできるDash、Zealというアプリケーションがあります。 Sphinxで作成されたHTMLのドキュメントをこのアプリケーションに取り込み、連携させる方法を紹介します。

目的

ドキュメントの検索性が高まると利用頻度が増え、ドキュメントを書くモチベーションも高くなります。良いドキュメントを作成するサイクルのヒントになると思います。

概要

Sphinxが管理するオブジェクトをDashアプリケーションがデータベースに取り込むキーワードとして扱うことで、Dashと連携させます。 reSTで書かれたドキュメントから、Dashが扱うdocsetを生成する流れを説明します。
  • このエントリーをはてなブックマークに追加