PyCharm (IntelliJ) で Sphinx で楽にドキュメントを書く - Qiita
何故 Sphinx なのか プロジェクトに参画していると仕様書を書き残したりプロジェクト固有のメモ書きなどを残したりしたい時がよくある。プロジェクトが Redmine などを使用している場合 Wiki に残すなどすれば簡単なのだが、そういった手段が使えないこともある。 そして、日本企業は Excel が大好き である。とかく何の仕様書だろうが Excel を多用する。だが個人的に以下の理由で Excel を使うのは好きではない: 閲覧には Microsoft 社が販売する製品が必要である。LibreOffice (OpenOffice) でも良いが再現性が完全ではない 構成にもよるがファイルを開くのに時間がかかる Git, Subversion などでドキュメントの差分を取るのに向いていない Sphinx は元々は Python のドキュメントを書くためのツールとして開発された経緯があるよ
Sphinxをはじめよう
本書には改訂版があります。 Officeツールを使用していて、思うようにならずストレスを感じる事はありませんか？あるいは、印刷用の資料を見ている時に、Webブラウザで閲覧しやすいフォーマットになっていて欲しいと思ったりはしませんか？ 本書はPythonで標準的なドキュメント作成ツールとして利用されているSphinxの入門書です。Windows、OS X、Linux（Ubuntu）を例に、Sphinxの概要からインストール、基本的な利用法について。またSphinxからLaTeXを経由してPDFを作成したり、EPUBフォーマットの電子書籍を作成する方法を、初めて触れる方にもわかりやすく紹介しています。 なお本書はEbook版のみの販売となります。 はじめに 本書を読むにあたって必要な環境とバージョン 本書が想定する読者 本書で使用されている表記規則 サンプルコードの使用について 本書に関するお
独学Linux : ゼロからはじめるSphinx《入門編》
1月11 ゼロからはじめるSphinx《入門編》 カテゴリ:Ubuntu 11.10TeX Sphinxは、HTML文書・LaTeXを用いたPDFファイル・EPUB形式の電子書籍などを同一のソースファイルから作成できるドキュメント作成プログラムです。通常のプログラムのコンパイルのように、makeコマンドを使ってそれぞれの形式の文書を作成します。 Sphinxのソースファイルは、reStructuredText（拡張子は .rst）と呼ばれるマークアップ言語で記述します。以下に、サンプルをお見せしますが、これらはすべて特別なレイアウト調整を行っておらず、デフォルトのレイアウトを使っています。このように、非常に完成度の高い多様な文書が同一のソースから作成できるというのは魅力的ですね。 以下、Ubuntu 11.10(oneiric)でSphinxを使ってみたという備忘録です。 詳細は、Sphi
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
システム開発や保守、運用の現場においてドキュメントは必須のものです。 しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュ メントが存在しない、資料が古いままになっているなどといった現状を多く 耳にします。 本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、 みるみるうちに図を作成できる「blockdiag」をご紹介します。 「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの 画像ファイルを出力可能なオープンソースの画像生成ツールです。書き やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに 配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちら このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成 するツール「Sphinx」を組み合わせることによって
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
執筆中のPythonプロフェッショナルプログラミング第2版でsphinxを使っている話
