Talk Submission
If you are interested in attending this talk at PyCon JP 2016, please use the social media share buttons below. We will consider the popularity of the proposals when making our selection.
talk
Sphinxで作成したドキュメントをDashに取り込む方法(ja)
Speakers
togakushi
Audience level:
Novice
Category:
Documentation
Description
HTMLで作成されたドキュメントを取り込み、キーワードをローカルでインクリメンタルサーチできるDash、Zealというアプリケーションがあります。
Sphinxで作成されたHTMLのドキュメントをこのアプリケーションに取り込み、連携させる方法を紹介します。
Objectives
ドキュメントの検索性が高まると利用頻度が増え、ドキュメントを書くモチベーションも高くなります。良いドキュメントを作成するサイクルのヒントになると思います。
Abstract
Sphinxが管理するオブジェクトをDashアプリケーションがデータベースに取り込むキーワードとして扱うことで、Dashと連携させます。
reSTで書かれたドキュメントから、Dashが扱うdocsetを生成する流れを説明します。