プロポーザル

これは応募されたプロポーザルです。聞きたいと思うプロポーザルを各ページの下部にあるSNSのボタンで拡散しましょう。拡散された投稿をプロポーザルへの投票としてカウントし、選考時に参考にさせていただきます。

talk

世界でいちばん簡単なSphinx入門(ja)

スピーカー

Toshiyuki Ishii

対象レベル:

初級

カテゴリ:

Documentation

説明

Sphinxは非常に強力なPython製のドキュメンテーションツールです。 Pythonだけではなく、LinuxカーネルやCakePHPなど他言語の著名なOSSのドキュメントに使用されています。 しかし、導入に際してreStructuredTextの壁、設定の煩雑さなどが原因で二の足を踏んでいる方が多いと思います。 本セッションではマークダウンとGUIを使い、世界でいちばん簡単なSphinx入門をお教えします。

目的

Sphinxで一番最初にぶつかるreStructuredTextの壁をマークダウンで回避し、Sphinxの便利な機能を体験してもらう。

概要

Sphinxを始めるに当たって一番の障壁となるのはreStructuredTextでしょう。 GitHubをはじめ多くのWebサービスがマークダウンを採用しています、すでにマークダウンで書かれたドキュメント資産があるという方もいるでしょう。 しかし、SphixでマークダウンとreStructuredTextが併用できたら便利だと思いませんか? Sphinxをはじめようとしたけど`conf.py`の設定が難しくて断念した方はいませんか? もし、GUIから数回のマウスクリックでSphinxのドキュメントが作成できたら便利だと思いませんか? 本セッションでは、GUIとマークダウンを使った世界でいちばん簡単なSphinxの使い方をお教えします。
  • このエントリーをはてなブックマークに追加
CONTACT