ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
システム開発や保守、運用の現場においてドキュメントは必須のものです。 しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュ メントが存在しない、資料が古いままになっているなどといった現状を多く 耳にします。 本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、 みるみるうちに図を作成できる「blockdiag」をご紹介します。 「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの 画像ファイルを出力可能なオープンソースの画像生成ツールです。書き やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに 配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちら このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成 するツール「Sphinx」を組み合わせることによって
Sphinx逆引き辞典 — Sphinx逆引き辞典 (ver. 2011-06-17)
ナビゲーション 索引 次へ | Sphinx逆引き辞典 (ver. 2011-06-17) » Sphinx逆引辞典は、sphinx-users.jpに移転しました 移転先 bitbucketレポジトリ¶ レポジトリ Issueリスト 目次 Sphinx逆引き辞典 bitbucketレポジトリ todoリスト Indices and tables 次のトピックへ reST/Sphinxを使うときの最初の一歩 このページ ソースコードを表示 クイック検索 モジュール、クラス、または関数名を入力してください ナビゲーション 索引 次へ | Sphinx逆引き辞典 (ver. 2011-06-17) » © Copyright 2011, shirou(r_rudi). このドキュメントは Sphinx 1.0.7 で生成しました。
rst2pdf - Google Code
Intro The usual way of creating PDF from reStructuredText is by going through LaTeX. This tool provides an alternative by producing PDF directly using the ReportLab library. More information is available at the main website Features User-defined page layout. Multiple frames per page, multiple layouts per document. Page transitions Cascading stylesheet mechanism, define only what you want changed.
渋日記: Pythonって何？という人のためのSphinxチュートリアル
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 前回、インストールのエントリーを書きましたが、Tornadeドキュメントの翻訳を例に、実際にSphinxでの作業の流れをお見せしたいと思います。 まずはワークフォルダを作る 作業をするには、ファイルを置く場所が必要です。ソースコード、設定ファイル、ビルド後の成果物などなど、いろいろ必要になります。そこでフォルダを作成する必要があります。僕の場合は翻訳とかの作業は(ホーム)/work/(作業フォルダ)という場所で行うことが多いので、その前提で話しをすすめます。Tornadoの翻訳の場合はチームで作業をしたので、bitbucketを使って共有環境を用意しましたのでその説明も一緒に。 共有をする場合はMercurialをインストールしてください。Windowsの場合はTortoise
Overview — Sphinx v1.0 (hg) documentation
ダウンロード このドキュメントはバージョン1.0 (hg)のためのものです。まだリリースされていません。 Mercurialリポジトリのコードを利用するか、Python Package Indexにあるリリースバージョンを探してください。 疑問? 意見? Googleグループへの参加: もしくは、FreeNodeの#python-docsチャンネルへどうぞ 何か気づいたことがあれば、issue trackerを使用して通知することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。そして、今までに数々のPythonや、他の言語で開発されているプロジェクトに対して、すばらしいドキュメンテーシ
Shibu's Diary: とちぎRuby会議02 - その1(LT)
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 とちぎRuby会議02がありました！普段は技術や「普及するには？」ということについて語られることが多いIT系イベントですが、仕事としてのマインドについて多くのメッセージを聞くことができました。今回はその中でLTの発表をしてきましたので、スライドとスクリプト(時間の関係でかなり削りましたが)を公開します。裏切り者感たっぷりのスライドですが、最後までおつきあいください。 今回ご紹介したいものが、このSphinxです。 Wikiみたいなプレーンテキストの簡易マークアップから整形してくれるツールです。相互リンクも張ったり、索引を作ったりもしてくれる。LaTeXを経由しないPDF出力は現在活発に開発されている部分。これができるとかなり強力です。コードハイライトも、nginxというリバース
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
カスタムのインラインマークアップを定義する方法
はてなブログ | 無料ブログを作成しよう