sphinxってプロジェクトのドキュメント作成に使われる事は多いですか。

Question

既存のプロジェクトのドキュメントの作成にsphinxが使われておりました。今まで知らないツールだったのでどんなメリットがあるか知りませんが、結構現場で使われる事が多いのでしょうか。

Answer 1

Sphinx & blockdiag Advent Calendar（全部俺）アドベントを電子書籍化されたものですが、色々な事にチャレンジされており、読んでみると書きたくなってきます。
・・・が、私のところでは、markdownが主流(wiki)で、reSTは敷居が高いということもあり、その恩恵にあずかることができていないです。変換ツール(markdown->reST)もありますが、blockdiagなどの恩恵を享受できない(書き方がわからない？！)で、流行らせる事ができていないでいます。

netdiagなど、データベースからパースしてこの形式で張り付けるだけで、きれいに図示してくれるなど、ちまちまMSソフトと格闘しなくても良いなど、導入に向けて暗躍している所です。

テキストなので、git管理などして、バージョン管理が容易にできる為、更新頻度の高いドキュメントこそ、採用すべきだと感じます。

Comments

[退会済みユーザー]

ご回答ありがとうございます。現状はそこまで、流行っていないのですね。しかし、メリットも多そうです。

[Ken.sakanakana]

うちの会社は・・・と、いうことでご理解くださいm(_ _)m
そもそもMicrosoft文化の強いごく一般的な会社なので、こういった試みが受け入れられずらいという事もあり、折角のこういった強力なツールの恩恵に与れないという悲しい状況です。;-)

開発をされる方々の効率をあげる良いものだと、私自身はおもいます！

[退会済みユーザー]

>うちの会社は・・・と、いうことでご理解くださいm(_ _)m
すいません。読み違えました。

今回このような質問をした目的は、普及が進んでいるのであれば、使い方を覚えた方がいいのかなと思い質問致しました。

まだ、参考サイトを読み進めている段階ですが、便利なのであれば是非使っていこうと思います。

[Ken.sakanakana]

Office系のようは万人受けするものではありませんが、その道の人には有名なツールなので、覚えて損は無いと思います！

http://www.slideshare.net/kk_Ataka/jus-sphinx-sphinx-54608065?qid=9569a15e-009a-4194-8c9e-e3d67cd23d33&v=qf1&b=&from_search=1

Answer 2

Sphinxでドキュメント書き始めないか?

reStructuredText(以下reSTという文法で書かれたテキストファイルを

Sphinxに食わせてあげることで、html形式やLaTeX形式、man(Linuxのmanコマンドで表示されるページ)、
拡張すればPDF形式など、多様な形式に出力することが出来ます。

が参考になるでしょうか？

Comments

[退会済みユーザー]

参考サイトありがとうございます。