GitHub - deceze/Sphinx-HTTP-domain: Sphinx domain to mark up RESTful web services in ReST.You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
システム開発や保守、運用の現場においてドキュメントは必須のものです。 しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュ メントが存在しない、資料が古いままになっているなどといった現状を多く 耳にします。 本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、 みるみるうちに図を作成できる「blockdiag」をご紹介します。 「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの 画像ファイルを出力可能なオープンソースの画像生成ツールです。書き やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに 配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちら このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成 するツール「Sphinx」を組み合わせることによって
GitHub - michaeljones/sphinx-to-github: Sphinx extension & script to prepare Sphinx html output for github pages.
Sphinx to GitHub ATTENTION! This project is designed to help you get around the github-pages Jekyll behaviour of ignoring top level directories starting with an underscore. This is solved in a much neater way by creating a .nojekyll in the root of you github-pages which will disable Jekyll as described here and here. This makes this project largely useless! Thank you to acdha for making me aware o
Sphinxマークアップ集 — Sphinx v1.0 (hg) documentation
Sphinxマークアップ集¶ Sphinxは標準のreSTに対して、数多くの新しいディレクティブとテキストの解釈を追加しています。このセクションでは、これらのサポート機能のリファレンスを提供します。 モジュール用のマークアップ オブジェクト説明のためのディレクティブ シグニチャ 詳細情報フィールドのリスト コマンドラインのプログラムのマークアップ 説明のためのディレクティブのカスタマイズ パラグラフ階層のマークアップ 目次のマークアップ インデックス生成のためのマークアップ 文法規則表示 コードサンプルの表示 行番号 インクルード インラインマークアップ クロスリファレンス文法 Pythonオブジェクトのクロススリファンレス C言語の要素へのクロスリファレンス 他の要素へのクロスリファレンス 自由な場所へのクロスリファレンス ドキュメントのクロスリファレンス ダウンロード可能なファイルへの
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
RESTful web service API documentation with Sphinx
