Sphinxでドキュメントを書こう

2,602 views

Published on

0 Comments
4 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
2,602
On SlideShare
0
From Embeds
0
Number of Embeds
1,219
Actions
Shares
0
Downloads
9
Comments
0
Likes
4
Embeds 0
No embeds

No notes for slide

Sphinxでドキュメントを書こう

  1. 1. Sphinxでドキュメントを 書こう @kzfm
  2. 2. Sphinx•  文書作成ツール•  http://sphinx-doc.org/ (本家) –  http://sphinx-users.jp/ (日本語)•  ReSTで書いて出力 –  html,docx,pdf,epub –  多数のフォーマット対応
  3. 3. HTMLに変換 h"p://www.kzfmix.com/flaski/
  4. 4. epub -> mobi -> kindle
  5. 5. INSTALL & QUICK START
  6. 6. install & quick start$  mkvirtualenv  sphinxtest  (virtualenvで使う時)  $  pip  install  sphinx  #  quick-‐‑‒start  $  mkdir  testdoc;  cd  testdoc  $  sphinx-‐‑‒quickstart  Welcome  to  the  Sphinx  1.2b1  quickstart  utility.  ###  質問に答えていくとひな形ができる  ###  Enter  the  root  path  for  documentation.  >  Root  path  for  the  documentation  [.]:  
  7. 7. 出来たひな形 $  tree   .   ├──  Makefile   ├──  _̲build   ├──  _̲static   ├──  _̲templates   ├──  conf.py   ├──  index.rst   └──  make.bat   3  directories,  4  files  rstファイルを追加してmake [html,epub,etc]でドキュメント作成
  8. 8. TIPSとか
  9. 9. MSWord•  sphinx-docxbuilderエクステンショ ン –  サラリーマンの必需品$  mkdir  exts  $  cd  exts/  $  hg  clone  https://bitbucket.org/haraisao/sphinx-‐‑‒docxbuilder  
  10. 10. epub -> mobi•  現状Sphinxだけでは難しそうなので epubをmobiに変換している•  kindlegen (amazon製) –  http://www.amazon.com/gp/feature.html? ie=UTF8&docId=1000765211•  calibre –  http://calibre-ebook.com/
  11. 11. Emacs ReST-mode 便利なキーバインドがたくさんあるよ
  12. 12. GitHubでSphinxを使う1.  gh-pagesというブランチを作る2.  sphinxtogithubというエクステンショ ンを入れる3.  Sphinxで文章を書く4.  make htmlする5.  cp -pr _build/html/* ./でビルドされた htmlをカレントディレクトリに移動する6.  commitしてpushすると公開できるよう になる
  13. 13. 例)ゆるふわHaskell三島Haskell無名関数の会では、一緒にHaskellを学ぶそこのあなたをお待ちしています
  14. 14. デプロイ•  Makefileに書く•  fabricを使う –  わからないことは@ando_ando_ando先 生に聞こう!(お気軽に)
  15. 15. 更新検知 -> make -> browser reload•  python-livereloadを使おう –  https://github.com/lepture/ python-livereload•  Sphinx と LiveReload を組み合わせ る –  http://kshigeru.blogspot.jp/ 2013/02/sphinx-livereload.html
  16. 16. demo
  17. 17. まとめSphinx快適ですよ

×