Swaggerを使ってインタラクティブなWeb APIドキュメントをつくる - Qiita
この記事は、微妙に以下の記事の延長線上です。わかりにくければ、こちらから読んでいただいた方がいいかもしれません。 LittleBitsを使ったIoTをつくり、家の室温変化のグラフをインターネットから見る（前編） - Qiita 「インタラクティブなWeb APIドキュメント」とはどういうものか Swaggerというツールを使います。Web APIをYAMLで書いておいて、Swaggerでサーバを立てると、読むだけのドキュメントではなくて、以下のようにパラメータを指定して実際にHTTPリクエストを送ることができるWebページが生成されます。 以下が返ってきたレスポンスです。 以下は実物です。ご自由に動かしてみて下さい。 インタラクティブなWeb APIドキュメント まだちょっと分かりにくいという方のために、アノテーションからドキュメントを作れるswaggerの使い方 - gong023の日記
reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。
Sphinxを使って論文っぽい文章を書くときのtipsをまとめておきます。 追記: この内容は Sphinx逆引き辞典により詳細にして載っています。 用語を書く際はreplaceを使う .. |hoge| replace:: ほげらこう定義しておくと次からは |hoge| とするだけで、ほげらと自動的に展開してくれます。つまり、あとからこの用語名を変えたいな、と思ったときにはこの定義のところだけを変えれば勝手に全部入れ替えてくれる、というわけです。 ただし、複数のrstファイルに分けている場合には使えないので、別のファイル(例えばdefinition.txt)に replace を書いておき、 .. include:: definition.txtと各rstファイルの先頭に書いておきます。この時、.rstではなく.txtなど他の拡張子のファイルに書いていることに注意してください。そうしない
Markdownテキストでシーケンス図とフローチャートを描く - Qiita diagram sequence
つい先日、とあるシステムの処理の流れと一部処理のフローチャートを付けた見積り資料を書くことになり、ちょうど良い機会だったので、MarkdownでUML図表が描ける「StackEdit」を使って、オールMarkdownで資料を作成してみた。 いやぁ、打ち込んだテキストがリアルタイムに図表化されていく様は、とても新鮮で、そしてすごく面白かった。資料が出来上がった後の達成感というか、完成した図表を見た時の感動が結構はんぱない。技術系の資料作成でこんな良い体験ができたのは初めてかもしれんな…(笑) ──と、結構感動的な体験ができるMarkdownでのUML図表作成なんだが、せっかくなのでそれの書き方を含めてもう少し突っ込んだTIPSとしてまとめておこうかと思った次第。 Markdown+UML とは？ とりあえず、「Markdown+UML」というのは私の造語だ。まぁ、正確に言うなら「UML di
Markdownで書いたドキュメントをSphinxで閲覧するまで、Gruntを使ってある程度自動化してみた - Qiita
Markdownで書いたドキュメントをSphinxで閲覧するまで、Gruntを使ってある程度自動化してみたMarkdownPandocSphinxgrunt Markdownで書いたドキュメントをSphinxで閲覧するにはpandocでreStructuredTextに変換し、その後make htmlするのが一般的？な流れだと思うが、都度都度ビルドするのも面倒なのでGruntを使ってタスク化してみました。ついでにgrunt-este-watchとgrunt-contrib-connectでMarkdownファイルが編集されたらビルドとブラウザリロードをするようにしてみました。 Gruntfile.jsは以下のような感じです。 var fs = require("fs") , exec = require('child_process').exec; module.exports = fun
ドキュメント作成ツールの検討(Sphinx、ReVIEWとか) - wadahiroの日記
今後、マニュアルを書いてメンテナンスも継続的にしていく機会が丁度ありそうなので、現時点(2012/05/02)でどのツールが自分たちにフィットするか検討してみた。ツールの候補は以下。なお、過去の仕事ではWordとDocBookは経験あり。 Word DocBook Sphinx ReVIEW 前提 今回のマニュアル作成の前提は以下の通り。 複数人で作業し、1つのドキュメントを作成する(主に章単位でアサイン)。 特定顧客向けに部分的にカスタマイズして提供することもある。 外部向けのドキュメントなので、体裁はそれなりに整っている必要がある。 製品のエディションによってマニュアル構成が変わる(上位のエディションだと機能が増えるので章や節、説明が増えるなど)。 出力フォーマットはWordまたはHTMLならOK。PDFは必須ではない。 ドキュメント中に画像はそれなりにある。スクリーンキャプチャ、構成
概要 — Sphinx 1.1 (hg) documentation
ダウンロード このドキュメントはバージョン1.1 (hg)のためのものです。まだリリースされていません。 Mercurialリポジトリのコードを利用するか、Python Package Indexにあるリリースバージョンを探してください。 疑問? 意見? Googleグループへの参加: もしくは、FreeNodeの#pocooチャンネルへどうぞ 何か気づいたことがあれば、issue trackerを使用して通知することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。Pythonのプロジェクトのためのすばらしい機能を提供してきましたが、現在ではC/C++も既にサポートしています。また、他
documentr – documentr
documentrCommunityDevelopmentDownloadInstallationMarkupPermissionsProjects, Branches and PagesScreenshotsdocumentr is a Web-based tool to edit and present software documentation. It allows to easily maintain documentation for multiple products and product branches. Documentation follows your branches - You can create branches of your documentation just as you would with your product's source code.
)
Endpoint Protection
Updated: April 1, 2015 Applies To: System Center 2012 Endpoint Protection, System Center 2012 R2 Endpoint Protection, System Center 2012 Endpoint Protection SP1 Microsoft System Center 2012 Endpoint Protection provides an antimalware and security solution for the Microsoft platform. When System Center 2012 Endpoint Protection is used with Microsoft System Center 2012 Configuration Manager, it prov
)
Data Protection Manager (DPM)
Updated: May 13, 2016 Applies To: System Center 2012 SP1 - Data Protection Manager, System Center 2012 - Data Protection Manager, System Center 2012 R2 Data Protection Manager Deploy System Center 2012 – Data Protection Manager (DPM) to back up servers, computers, Microsoft workloads, system state, and bare metal recovery (BMR). Get Started with DPM—Learn what’s new, verify system requirements and
ブロック図生成ツール blockdiag — blockdiag 1.0 ドキュメント
ブロック図生成ツール blockdiag¶ blockdiag シリーズはシンプルなテキストからブロック図などの画像を生成する画像生成ツール群です。 blockdiag を用いると以下のような図が簡単に生成できます。 blockdiag の主な機能: 数種類の図に対応 ブロック図 (blockdiag コマンド) シーケンス図 (seqdiag コマンド) アクティビティ図 (actdiag コマンド) 論理ネットワーク図 (nwdiag コマンド) テキストベースの定義ファイルから画像ファイルを生成 (graphviz 風の文法を採用) 定義にあわせて図の配置を自動的に決定 (自動レイアウト) Sphinx, Trac, Redmine, 各種 Wiki エンジン等、多様なシステムへの画像埋め込みに対応 Enjoy documentation with blockdiag !
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の
sphinx でtext からドキュメント作成 - うまいぼうぶろぐ
http://sphinx-users.jp/index.html http://sphinx.shibu.jp/ http://labs.timedia.co.jp/2011/05/sphinx-blockdiag-yokohamapm-201105.html このような、プログラマーがドキュメントを書きたくなってしまうすばらしいツールに乾杯！” reST(reStructuredText; HTTP の RESTじゃないyp) でテキストを書いて、ドキュメントに変換する。markdown、wiki記法みたいなもの？ blockdiag からsphinx を知ったんですが、なかなか良い感じですね。make html, make pdf, make latex, などで色々作れるし！ make pdf するには rst2pdf というpython ライブラリがいるのでeasy_instal
Internet Week 2011 T3 運用ドキュメント2011～手軽にスピーディに継続的に保守するためのツール入門～ - JPNIC
日時 2011年11月30日 16:00～18:30 会場 富士ソフト アキバプラザ プログラム紹介ページ (敬称略) タイトル 講演者 配布資料 (PDF)
情報処理推進機構：ソフトウェアエンジニアリング：報告書：非機能要求グレードの公開
～システム基盤における非機能要求の見える化ツール～ 2018年4月25日更新 2010年4月 独立行政法人情報処理推進機構 技術本部 ソフトウェア高信頼化センター 概要 情報システムの開発では、業務機能に関する要求以外のいわゆる「非機能要求」について、発注者と受注者との認識の行き違いや、互いの意図とは異なる理解をしたことに気づかないまま開発が進んでしまうことがあります。 「非機能要求グレード」は、このような状態を防止することを目的とし、重要な項目から段階的に詳細化しながら非機能要求の確認を行うツール群です。 「非機能要求グレード」は、「システム基盤の発注者要求を見える化する非機能要求グレード検討会（※）」から譲渡を受けたものです。 また、非機能要求グレードの具体的な利用方法が体得できる演習付きの教材非機能要求グレード研修教材」と解説書「非機能要求グレード利用ガイド[活用編]」も公開していま
Web APIのテスト実行もできるWeb APIオンラインドキュメントシステム·I/O Docs MOONGIFT
I/O DocsはWebベースのWeb APIドキュメントおよびテスト実行環境を提供するソフトウェア。 I/O Docsはnode.js/JavaScript製のオープンソース・ソフトウェア。最近のWebサイトではWeb APIの提供が当たり前になっている。データを発信するだけでなく、OAuthを使って認証データやデータの更新権限を与えたりもする。 文字が大きめで分かりやすい そんなWeb APIをどう実行したら良いか、開発者向けのドキュメントは欠かせない。さらにその場で実行できると便利だ。それを可能にするのがI/O Docsだ。 I/O DocsはオンラインのWeb APIドキュメントだ。メソッドの一覧と、その際のHTTPメソッドが一覧で確認できる。各機能についてパラメータ名や種別、説明文も確認できる。ベーシックではあるが、Web APIとして最低限の機能が備わっている。 テスト実行した
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - sonodar/sphinx-plantuml-browsersync: Sphinx + PlantUML + Gulp + Browser-Sync
SIerでもSphinxを使いたい！総括
Charming Python: Functional programming in Python, Part 3
VMware vSphere のドキュメント