ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
システム開発や保守、運用の現場においてドキュメントは必須のものです。 しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュ メントが存在しない、資料が古いままになっているなどといった現状を多く 耳にします。 本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、 みるみるうちに図を作成できる「blockdiag」をご紹介します。 「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの 画像ファイルを出力可能なオープンソースの画像生成ツールです。書き やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに 配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちら このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成 するツール「Sphinx」を組み合わせることによって
sphinx + blockdiag で始めるドキュメント生活 2011/05 yokohama.pm
2016年7月のささみの会で発表した内容です。 当たりさわりの無い Sphinx についての紹介をしています。
sphinxcontrib-phpdomain
Classifiers Environment Console Web Environment Intended Audience Developers License OSI Approved :: BSD License Operating System OS Independent Programming Language Python Topic Documentation Utilities This package provides a Sphinx extension for documenting PHP projects. PHP Domain supports following objects: Global variable Global function Constants Namespaces Functions Class Class Class consta
Shibu's Diary: Sphinx紹介セッション@BPStudy #30
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 BPStudy #30に登壇してきました。ネタはSphinxの紹介です。資料はこちらにあります。Slideshareに上げてみたけど、固定長フォントが崩れて、ソースコードがうまく表示されないという、チュートリアルのテキストとしては大問題な感じだったので、ドキュメントがアップできるようになったというGoogle Docsを利用しました。いいですね、これ。Slideshareみたいに、ビュー数とか、ソーシャル機能がないのはちょっと寂しいけどね。 結果としては、Sphinxの良さを伝えることができたかな、と思っています。すごく反応して拡張機能に手を染め始めた人もいるし、僕自身も、Sphinxを紹介する武器として、今回スライドを作ることができたので、今後はいろんなところで生かして行きた
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
sphinxjp.themes.bizstyle · PyPI
逆引き辞典
ドキュメントを作りたくなってしまう魔法のツールSphinx
