Sphinx: webアプリケーション化する試み

Sphinxは、reStructuredTextが(記述されたテキストファイルが)配置されたディレクトリを元に、各種装飾つきドキュメントが配置されたディレクトリを生成/更新するツール。基本的にmakeなどと連携する。 http://sphinx-users.jp/doc10/ 編集者のコンピュータで実行するという前提であれば、複雑な事前処理を実行させたり、ロックなしのリビジョン管理なども実現できるが、環境をセットアップする労力や技術的な経験が必要になる。
1
hirsato @hirsato

プレーンテキストによる簡易マークアップというところはwikiと一緒である。レンダリングはコンパイル。静的なHTMLが出力される。LaTeXなども出せる。バージョン管理は持っていない。自分の好きなものを利用する。キーワードはツリー構造。 ^HS #infotalk

2010-08-20 19:15:11
hirsato @hirsato

JavaDoc: ソースコードから情報抽出。編集はソースコードを編集。クラス/関数に大してリンク。ソースコードの構造によるツリー構造。 ^HS #infotalk

2010-08-20 19:15:55
hirsato @hirsato

Sphinx: ツリーによるロジカルな構造が作れる。水平に広げられる。構造がぶれない。スモールリファクタリングがしやすい。ソースコードとの同期はとりやすい。(Pythonのみ) ^HS #infotalk

2010-08-20 19:17:04
hirsato @hirsato

Sphinx: Pythonで機能拡張できる。Mission: 人が読みやすい。 Oppotunity: ソースを書きコンパイル。 Requirement: 文章を書く能力。 ^HS #infotalk

2010-08-20 19:19:47
Tetsuya Morimoto @t2y

エキスパート Python プログラミングの Sphinx とドキュメントについて書かれている章は無料で公開されています http://bit.ly/dfJUpI #infotalk

2010-08-20 19:34:50
Tetsuya Morimoto @t2y

"人に聞かれる -> 口頭で説明する -> 文書化" この流れは良いね、話したり文章にまとめることそのものが思考の整理になる #infotalk

2010-08-20 19:37:12
hirsato @hirsato

HTMLでは場所がわからないとリンクが張れない。Sphinxの場合は、自動的にリンクできる。 ^HS #infotalk

2010-08-20 19:44:04
HATANO Hirokazu @tcsh

ReST対応WiKiがあれば、Sphinxの普及が早いと思うんだ。

2011-02-04 12:02:41
HATANO Hirokazu @tcsh

ReST WiKi(仮称、フロントエンド) -> ReSTデータ-(commit)-> リポジトリ -(checkout)-> 公開場所([Sphinx] build / make いろいろ) == 成果物

2011-02-04 12:08:57
no root, nobody @togakushi

TRAC にマクロがあったような…(使ったことないのでアレですがw QT @tcsh: ReST対応WiKiがあれば、Sphinxの普及が早いと思うんだ。

2011-02-04 12:10:43
HATANO Hirokazu @tcsh

ReST WiKiでの表示は、可能なら make html相当で (スタイルシートの共有が面倒か?

2011-02-04 12:10:43
HATANO Hirokazu @tcsh

pukiwiki並にライトでシンプルなの希望:-) RT @togakushi: TRAC にマクロがあったような…(使ったことないのでアレですがw QT @tcsh: ReST対応WiKiがあれば、Sphinxの普及が早いと思うんだ。

2011-02-04 12:11:46
Takayuki Shimizukawa @shimizukawa

これっすね http://bit.ly/dIam37 RT @togakushi: TRAC にマクロがあったような…(使ったことないのでアレですがw QT @tcsh: ReST対応WiKiがあれば、Sphinxの普及が早いと思うんだ。

2011-02-04 12:16:47
神速 @sinsoku_listy

TracWikiで {{{ #!rst <reST> }}} にするだけでも一応reST使える。

2011-02-04 12:24:20
HATANO Hirokazu @tcsh

reST + Sphinx実例ページ reST ディレクティブ編 GitHub wiki: http://bit.ly/icYfud / 出力例: http://bit.ly/i8T5mF #sphinxjp

2011-02-11 19:56:09
HATANO Hirokazu @tcsh

@voluntas あ、自分自身は日常生活 vi なので、あまり期待しないでください(笑 一般業務系のユーザ向けに pukiwikiの reST対応版みたいなのが欲しいと叫び歩く感じかもしれません

2011-02-11 23:48:44
Sho Shimauchi @shiumachi

ドキュメントを作りたくなってしまう魔法のツールSphinx http://htn.to/tsSwZo

2011-03-01 10:51:00
HATANO Hirokazu @tcsh

ドキュメントちーむに共有しつつあるんだけど、上手く喜びが伝わらない。Sphinx成功事例積み上げたいので、協力よろしくっす @shkumagai @yssk22 @kogee

2011-03-05 08:56:04
飽き性 @shkumagai

@tcsh 現在使っているツール(pukiwiki)の問題点と、そこに対するアドバンテージ(VCSで版の管理ができる、とか)を対比して見せるのが重要だと思ってます。あとは表現力の問題かな。。。

2011-03-05 08:59:50
HATANO Hirokazu @tcsh

@shkumagai 何よりも、Sphinx使っている人たちの工数がさがってモチベーションあがってます、というのが一番効果的かと(^_^

2011-03-05 09:04:54
heno @_heno

@tcsh @shkumagai リビジョン管理システム(というツールの難しさ)に対する壁と、Webインターフェースでない(かもしれない)部分のとっつき辛さの壁、といった様な運用の壁を乗り越えられるかどうか。現場を選ぶ物なのかどうか。Sphinxについてはその辺に注目しています。

2011-03-05 12:57:30
HATANO Hirokazu @tcsh

@_heno pukiwikiには、公私でお世話になってます。失礼ながらメンテナンス終わっていると思ってました(汗。ドキュメント管理システム内部を疎結合にすれば、バージョン管理はユーザからは隠蔽出来なくも無いのかなと思っています。(コンフリクトリカバリーの操作を除く)

2011-03-05 13:06:04
HATANO Hirokazu @tcsh

運用研究会セッションでも簡単に紹介しましたー RT @tk0miya: チラシが足らなくなるくらいに盛況。(snip) Wiki 連携や Web エディタ、自動ビルド(ホスティング)などの要望が出ていた。Symfony のセッションで触れられたらしい。 #sphinxjp

2011-03-06 00:26:07
HATANO Hirokazu @tcsh

@tk0miya 運用ドキュメントについて、メモ程度ですがざっくりまとめてみました。http://bit.ly/fZwI9d

2011-03-06 11:21:03
heno @_heno

@tcsh ふむふむ、やはりreSTが使えるCMSと組み合わせて、simplicityを強化する方向ですか。Webでラップすると、クライアント側の資源を活かせるというcliの利点と、リビジョン管理ツールの利点がトレードオフになったりしますが、釈迦に説法だったようですね (^^;

2011-03-06 23:09:52