タグ

sphinxに関するsyqueのブックマーク (2)

  • Sphinxでドキュメントを生成する - rabbit2goのブログ

    最近、Sphinxを使ってドキュメントを書いている。元々、Wordのようにチマチマと自分で文字のレイアウトや装飾を指定するタイプは好きではなく、LaTeXのように「プレーンテキストで文章を書いて、コマンド一発で出力を生成。レイアウト等は一切お任せ」型のシステムが好きなので、Sphinxはまさに好みのタイプと言える。 Sphinxのメリットを自分なりにまとめると次のようになる。 文書はプレーンテキストへ書く。実際の出力形態はSphinxへお任せ。 別ファイルに用意しておいた画像ファイルも取り込める。 HTML形式だけではなく、PDF形式等での出力も可能。 blockdiagやseqdiagなど、テキストで書いたコマンドで図面を生成して取り込み可能。 Windowsでの導入方法については下記のエントリが詳しい。 Sphinxでドキュメント生成-図を描く(Windowsでの始め方) - toru

    Sphinxでドキュメントを生成する - rabbit2goのブログ
    syque
    syque 2011/06/23
    Sphinxのメリットを自分なりにまとめると次のようになる。 文書はプレーンテキストへ書く。実際の出力形態はSphinxへお任せ。 別ファイルに用意しておいた画像ファイルも取り込める。 HTML形式だけではなく、PDF形式等での
  • Sphinxでmscgen / graphviz | Go for it!

    Sphinxでドキュメントを書いたりしています。 以前からシーケンス図やブロック図を描くのに それぞれ mscgen や graphviz といったツールを使っています。 これらのソフトウェアは、テキスト形式で定義を記述する(dot形式というらしい)と画像を生成してくれます。 単純に画像を作るだけならMicrosoft VisioやOmniGraffleでいいのですが、 テキストベースでドキュメントを書いている場合、いろんなアプリケーションを 横断しなくてはならず、ちょっと面倒なんですよね。 mscgenやgraphvizを使えばテキストファイルのみで管理することができるというわけです。 で、題。 Sphinxにはこれらの拡張が用意されています(標準ではないです)。 拡張を導入することでSphinxドキュメント内にdot記述をすることが出来るようになります。 http://package

    syque
    syque 2011/05/25
    sphinx の拡張に mscgen や graphviz を追加してシーケンス図、ブロック図を描画する方法
  • 1