Skip to content

Instantly share code, notes, and snippets.

@yuokada

yuokada/index.md Secret

Last active Dec 23, 2015
Embed
What would you like to do?
sphinxまとめ

入門

日本語サイトが充実してるので基本は日本語サイトのみみてればOK

Tips的なもの

あと、フォローする人

watchdog

rstファイルが更新されたら自動でビルドするように設定するために必要なモジュール

pip instal watchdog

omakeもmakeも使わずに、Sphinxドキュメントの継続的ビルド - Study08.net 対シンバシ殲滅用人型機動兵器

SimpleHTTPServer

出来たドキュメントの確認するためにapacheいれるの面倒くさいのでこれで代用

python -m SimpleHTTPServer 8080

http://localhost:8080/

Editer

vim派だけどあんまりプラグイン入れて使いこなしていないのでなんとも。

その他

  • 各ページのヘッダー・フッターになにか共通のコードを入れたいときは conf.py に設定を追加する
  • pythonのモジュールのドキュメントはsphinx製のものが多いのでそれを真似するとか。 コードはgithubにあがってるはず
  • 今回の公式サイトがsphinxでできてるのでこれのソース読むのが勉強になるかも
    PyCon APAC 2013 - PyCon APAC 2013
    dpursehouse / apac-2013.pycon.jp / source / — Bitbucket
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment