Sphinx-Users.jp :: ドキュメンテーションツール スフィンクス Sphinx-users.jp
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx （スフィンクス）の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
ドキュメンテーションを加速するストレスフリーの作図ツール『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 で生成しました。
sphinx + blockdiagがとっても最強すぎる件 - 猫型開発者
Yokohama.pmで @tk0miya さんが発表していた sphinx + blockdiag。 sphinxはテキストファイルをWiki記法みたいな書き方で書いてmakeするだけでhtmlとかpdfを生成してくれる魔法のツール。pythonで書かれてる。 blockdiagはテキストファイルから遷移図とかシーケンス図とかネットワーク図とかを生成できるツールで、sphinxのreSTファイル内に埋め込むことができる。 コードに対するドキュメントなどはコードに埋め込んじゃえばいいんだけど(pod,javadoc、いろいろあるよね)、設計に関するドキュメントだとか運用に関するドキュメントは別に書かないといけなくて、ついつい後回しにして、必要になった時には後の祭り…なんてことが結構ある。かと言って、開発初期とプロダクトが成熟してきたときでは仕様に結構な差があったりして、初期に書いたドキュメ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
