Contenu connexe
Similaire à Sphinxでドキュメントを書こう
Similaire à Sphinxでドキュメントを書こう (20)
Plus de Kazufumi Ohkawa (20)
Sphinxでドキュメントを書こう
- 3. HTMLに変換
h"p://www.kzfmix.com/flaski/
- 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. 出来たひな形
$
tree
.
├──
Makefile
├──
_̲build
├──
_̲static
├──
_̲templates
├──
conf.py
├──
index.rst
└──
make.bat
3
directories,
4
files
rstファイルを追加してmake [html,epub,etc]でドキュメント作成
- 10. epub -> mobi
• 現状Sphinxだけでは難しそうなので
epubをmobiに変換している
• kindlegen (amazon製)
– http://www.amazon.com/gp/feature.html?
ie=UTF8&docId=1000765211
• calibre
– http://calibre-ebook.com/
- 15. 更新検知 -> make
-> browser reload
• python-livereloadを使おう
– https://github.com/lepture/
python-livereload
• Sphinx と LiveReload を組み合わせ
る
– http://kshigeru.blogspot.jp/
2013/02/sphinx-livereload.html