差分
この文書の現在のバージョンと選択したバージョンの差分を表示します。
両方とも前のリビジョン 前のリビジョン 次のリビジョン | 前のリビジョン | ||
programming:python:sphinx:start [2011/07/27 01:40] yuki |
programming:python:sphinx:start [2021/05/22 18:49] yuki 削除 |
||
---|---|---|---|
ライン 1: | ライン 1: | ||
- | ====== Sphinx ====== | + | ====== sphinx ====== |
pythonベースのドキュメント整形言語。とでも言えばいいのか。 | pythonベースのドキュメント整形言語。とでも言えばいいのか。 | ||
ライン 11: | ライン 11: | ||
* http://sphinx-users.jp/gettingstarted/install_windows.html | * http://sphinx-users.jp/gettingstarted/install_windows.html | ||
* 割と書いてある通り。Python 2.7.2でも順当に動く。 | * 割と書いてある通り。Python 2.7.2でも順当に動く。 | ||
- | * [[.:win-install-log]] | ||
* "make html"とだけ書いたバッチファイル作って楽しよう。 | * "make html"とだけ書いたバッチファイル作って楽しよう。 | ||
- | * _buildの中身のindexにショートカット作って楽しよう。 | + | * _build/htmlの中身にショートカット作って楽しよう。 |
+ | * バージョン管理はsubverionとかgitとかMercurialとか? | ||
+ | * 例 : http://togakushi.bitbucket.org/bitbucket.html | ||
* 描画補助 | * 描画補助 | ||
ライン 24: | ライン 25: | ||
* http://blockdiag.com/blockdiag-ja/build/html/index.html | * http://blockdiag.com/blockdiag-ja/build/html/index.html | ||
* ブロックダイアグラム生成ツール。 | * ブロックダイアグラム生成ツール。 | ||
+ | * 単品で使う | ||
+ | * easy_install blockdiag | ||
+ | * sphinxと組み合わせて使う | ||
+ | * easy_install sphinxcontrib-blockdiag | ||
+ | * conf.pyに追記 | ||
+ | * <code> | ||
+ | extensions = ['sphinxcontrib.blockdiag'] | ||
+ | blockdiag_fontpath = 'C:\windows\fonts\meiryo.ttf'</code> | ||
* windowsで使用する場合は、今でも問題が起きるかもしれない。 | * windowsで使用する場合は、今でも問題が起きるかもしれない。 | ||
* http://99blues.dyndns.org/blog/2011/01/blockdiag_for_win/ | * http://99blues.dyndns.org/blog/2011/01/blockdiag_for_win/ | ||
ライン 37: | ライン 46: | ||
* 単品でも割と有名なダイアグラム生成ツール | * 単品でも割と有名なダイアグラム生成ツール | ||
* DOT言語使うアレ | * DOT言語使うアレ | ||
+ | |||
+ | * とても参考になる | ||
+ | * http://yutuki.blogspot.jp/2012/01/sphinxhtmlpdf.html | ||
+ |