Sphinx の紹介

Sphinx とは？

� Python 製のドキュメント作成ツール

� Docbook と同じ類のツール� あるフォーマットで書かれたテキストを変換

� html

� latex

� pdf

� man page

� epub

� etc…

使ってみる(1)

$ sphinx-quickstart

$ lsMakefile* _build/ _static/ _templates/conf.py* index.rst* make.bat*

#ドキュメント名の入力

#著者の入力

#Version

#etc…

使ってみる(2)

$ makePlease use `make <target>' where <target> is one ofhtml to make standalone HTML filesdirhtml to make HTML files named index.html in directoriessinglehtml to make a single large HTML filepickle to make pickle filesjson to make JSON fileshtmlhelp to make HTML files and a HTML help projectqthelp to make HTML files and a qthelp projectdevhelp to make HTML files and a Devhelp projectepub to make an epublatex to make LaTeX files, you can set PAPER=a4 or PAPER=letterlatexpdf to make LaTeX files and run them through pdflatextext to make text filesman to make manual pages

使ってみる(3)

$ make html

HTML が出力される！

ドキュメント検索

インデックスなど

Sphinx の機能

� インデックス，用語集など

� 全文検索機能 (javascript)

� コードハイライティング

� 数多くの言語サポート

� ドキュメントツリーの操作機能

� デザインカスタマイズ

� etc…

Sphinx が実用例

� Python 本家のドキュメント

� Python モジュールのドキュメント

� kumofs

� （個人的に）Linux Kernel のドキュメント

Misc

� ドキュメント作成は簡単になったが，アップロードするには？

� Django のWebアプリケーション lionet など

� まだ発展途上の機能

� 全文検索機能

� 時系列管理？