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. Dismiss alert
Generating REST service documentation for the enterprise Download .zip Download .tar.gz View on GitHub Benefits Enables the creation of an enterprise REST service documentation web portal, providing a central port of call for service consumers Enables automatic generation of documentation from underlying service source code, thus ensuring the documentation is always up to date Features Displays Sp
I love documentation. If you work with/are writing code intended for usage and consumption by more than one person, you should love it, too. Documentation and other resources will make or break the success of your project. And the more open and collaborative you want development to be, the more crucial docs become. With that in mind, here's a list of docs and other developer resources that myself
システム開発や保守、運用の現場においてドキュメントは必須のものです。 しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュ メントが存在しない、資料が古いままになっているなどといった現状を多く 耳にします。 本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、 みるみるうちに図を作成できる「blockdiag」をご紹介します。 「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの 画像ファイルを出力可能なオープンソースの画像生成ツールです。書き やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに 配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちら このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成 するツール「Sphinx」を組み合わせることによって
YARDのことの続きを書きたいと思いつつもなかなか辿りつきません。今回はPython製のドキュメントツールSphinxの話です。groongaのケースを例にしてSphinxで複数言語用のドキュメントを生成する方法の概要を紹介します。書いていたら長くなったので、具体的にどうするかというのは次の機会にします。 5/29にgroonga 1.2.2がリリースされました。今後は日本だけではなく世界でも使ってもらえるように、英語でも情報を発信していく方向になりました。そこで、今回のリリースに合わせてサイトデザインをリニューアルし、英語のページも用意しました。ただし、すでにあった日本語のコンテンツを今回のリリースで全部英語にした、というものではありません。今回のリリースでやったのは「日本語と英語という複数の言語で情報を発信する仕組み」を作るところまでです。せっかくなので、今回のリリースで導入した、Sp
Series: Writing Great DocumentationA series of articles laying out the tools, tips, and techniques I’ve learned over the years I’ve spent helping to write Django’s docs. Writing Great Documentation: You need an editor November 12th, 2009I’m supposed to be this expert on writing, right? So how come my previous articles have had so many errors? Simple: my blog doesn’t have an editor. That’s typical
Hello JsDoc Toolkit † JavaScript専用のドキュメントジェネレータ。 Natural Docsの様に冗長にならずに、Javadoc風の記述が可能。 JSDocよりも正確に文法を解釈できる。 生成処理は全てJavaScriptで書かれているので、カスタマイズも容易。 日本ではいまいち認知度が低いようだけど、 僕の知る限り最高のJavaScriptドキュメントジェネレータ。 Related Links † JsDoc Toolkit JSDoc Natural Docs Install † OSXしか試していないけど、 cdで移動しないと正常に動作しないので、※ パス指定できない、改善希望 使い易い場所が良いと思う。 Command Line Options †
Unmatched price-performance 10X Better Price-performance than Redshift 15X Better Price-performance than Snowflake 2,200X Better Price-performance than Aurora Available on OCI, AWS, and Azure MySQL and HeatWave Summit May 1, 2024 - Redwood Shores, California MySQL and HeatWave Summit is where developers, DBAs, experts, and users come to learn about the latest innovations on-premises and in the clo
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く