ドキュメンテーションツール「Sphinx」をチーム運用するまでの道のり - Librabuch | sphinx_documentation_advent_calendar_2013
本エントリは、次のAdvent Calendarのために書かれたものです。 ドキュメンテーション Advent Calendar 2013 （12月15日） 取り扱う内容 株式会社ALBERTのシステム開発部では、ドキュメンテーションツールであるSphinxを積極的に活用しています。 Sphinxの導入、利用そのものは簡易に行うことができるのですが、開発部でチームとして運用するためにはいくつかの困難がありました。 そんな幾重にも張り巡らされた困難を乗り越えて、2013年11月頃から本格的に運用が出来ているなぁ、と実感するに至ったので、今回は2013年の総決算としてその変遷を綴ります。 関連資料 Pythonプロダクトを活用した開発チーム運営 in PyCon APAC 2013 - SlideShare SphinxをMarkdownで使い隊 - SlideShare Sphinxとわたし
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++も既にサポートしています。また、他
ブロック図生成ツール 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
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
http://nscom.ns-sol.co.jp/co4/app/main/select?pageId=44402
Charming Python: Functional programming in Python, Part 3