sphinxconjp2012.rst

Docutilsについて

DocutilsでHTMLを生成してみよう

• 2012.09.16
  • PyCon JP 2012
  • SphinxCon JP 2012

おまえ誰よ

name:	Keita Uchiyama (内山 景太)
twitter:	@hekyou
blog:	http://d.hatena.ne.jp/hekyou/
join:	#bookathon #expertpython
work:	組込 -> Web/アプリ -> インフラ

• Products
  • blockdiag pukiwiki plugin
  • Interactive shell live!! for blockdiag
  • docutils check tool

Docutilsって何？

• Python製のテキスト処理ツール群

何ができるの？

• reStructuredTextから他の形式に変換

今日扱う範囲

• reStructuredText -> HTML

試してみる -インストール-

$ pip install docutils
$ pip install Pygments

or

$ pip install Sphinx

• Sphinxインストール時にDocutilsもインストールされる

試してみる -reST作成-

$ vim foo.rst

Example
-------

* List1

  * SubList1
  * SubList2

* List2

試してみる -実行-

$ rst2html.py foo.rst > foo.html

試してみる -確認-

ここまでのまとめ

DocutilsでreStructuredTextからHTMLを生成するには

rst2html.py

を使うことで簡単にできる

第二部

Docutilsの中を見てみよう

第一部のおさらい

Docutilsの構造

Input

• 入力処理を請け負う
• 標準ではFileInputが使用される

Reader

• 読み込み処理を請け負う
• 読み込みたいデータと不要なデータを区別するように作ることが可能

Parser

• 指定フォーマットの解析処理を請け負う
• docutils独自のXMLに変換している
• 標準ではreSTの解析しか出来ないが他のフォーマットも追加することが可能

Transform

• 変換処理を請け負う
• 独自XMLに変換処理を加えたい場合に使用する

Writer

• 指定フォーマットへの変換処理を請け負う
• 標準で用意されていないフォーマットはWriterを追加することで可能になる

Output

• 書き込み処理を請け負う

Publisher

• それぞれの処理を実行する
• プログラム中からdocutilsを使うための関数がいくつか用意されている

publish関数

• プログラム中からDocutilsの機能を使う場合
  • publish系の関数を使用する

publish type

• publish_cmdline
• publish_file
• publish_string
• publish_parts
• publish_doctree
• publish_from_doctree
• ...

デモ

docutils check tool