OSS開発勉強会-01B

735 views

Published on

OSS開発勉強会-01B

Published in: Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
735
On SlideShare
0
From Embeds
0
Number of Embeds
5
Actions
Shares
0
Downloads
2
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

OSS開発勉強会-01B

  1. 1. Sphinx の紹介
  2. 2. Sphinx とは? Python 製のドキュメント作成ツール Docbook と同じ類のツール あるフォーマットで書かれたテキストを変換 html latex pdf man page epub etc…
  3. 3. 使ってみる(1) $ sphinx-quickstart $ ls Makefile* _build/ _static/ _templates/ conf.py* index.rst* make.bat* #ドキュメント名の入力 #著者の入力 #Version #etc…
  4. 4. 使ってみる(2) $ make Please use `make <target>' where <target> is one of html to make standalone HTML files dirhtml to make HTML files named index.html in directories singlehtml to make a single large HTML file pickle to make pickle files json to make JSON files htmlhelp to make HTML files and a HTML help project qthelp to make HTML files and a qthelp project devhelp to make HTML files and a Devhelp project epub to make an epub latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter latexpdf to make LaTeX files and run them through pdflatex text to make text files man to make manual pages
  5. 5. 使ってみる(3) $ make html HTML が出力される!
  6. 6. ドキュメント検索 インデックスなど
  7. 7. Sphinx の機能 インデックス,用語集など 全文検索機能 (javascript) コードハイライティング 数多くの言語サポート ドキュメントツリーの操作機能 デザインカスタマイズ etc…
  8. 8. Sphinx が実用例 Python 本家のドキュメント Python モジュールのドキュメント kumofs (個人的に)Linux Kernel のドキュメント
  9. 9. Misc ドキュメント作成は簡単になったが, アップロードするには? Django のWebアプリケーション lionet など まだ発展途上の機能 全文検索機能 時系列管理?

×