読者です 読者をやめる 読者になる 読者になる

「Sphinxをはじめよう」を上梓しました

@r_rudi, @shimizukawa, @usaturn の 3人と「Sphinxをはじめよう」を上梓しました *1

Sphinx 作者の Georg Brandl が来日していたときに話をしたのですが、
どうやら世界初の Sphinx 解説書籍のようです。
f:id:tk0miya:20130910171726j:plain:w240

オライリーさんの概要説明を引用します。

Officeツールを使用していて、思うようにならずストレスを感じる事はありませんか?あるいは、印刷用の資料を見ている時に、Webブラウザで閲覧しやすいフォーマットになっていて欲しいと思ったりはしませんか? 本書はPythonで標準的なドキュメント作成ツールとして利用されているSphinxの入門書です。Windows、OS XLinuxUbuntu)を例に、Sphinxの概要からインストール、基本的な利用法について。またSphinxからLaTeXを経由してPDFを作成したり、EPUBフォーマットの電子書籍を作成する方法を、初めて触れる方にもわかりやすく紹介しています。 なお本書はEbook版のみの販売となります。

目次はこんなかんじです。

  • はじめに
  • 1章 Sphinxとは
  • 2章 Sphinxのインストール
  • 3章 HTMLに変換してみよう
  • 4章 PDFに変換してみよう
  • 5章 EPUBに変換してみよう
  • 付録A reStructuredTextリファレンス
  • 付録B Sphinxが使える出力形式
  • 付録C TeX Live/MacTeXのインストール
  • 付録D Sphinx-users.jp

見ていただくとわかるかと思いますが、決して上級者向けではなく、
「これから Sphinx を使おう/使ってみたいな」と思っている方に向けた書籍です。
インストールからはじまり、HTML や PDF、ePub などのよく用いられる各種フォーマットへの変換を通して
Sphinx と reST を使って文章を書くことの基礎を紹介しています。

この本のねらい

これまで Sphinx のハンズオンを開催したり、外部のイベントに Sphinx の紹介をしに行ったり、
はたまたカンファレンスやハッカソンを開催するなどして、いろんな人に Sphinx を伝えてきたのですが、
その中で「分かりづらい」という声が上がったところや、Sphinx-users.jp のコンテンツで説明不足なところなどを整理して
あらためて「これから Sphinx をはじめる人」向けに説明を書き直しました。

例えば reST のインデントや改行は「なぜこうなっているのか」というのを理解していないと
いくつスペースを空けるべきなのか、ここに空行を入れるべきなのかどうかというのがすっきりしません。
この本ではいままでいろんな人がぶつかった「ハマりポイント」にスポットを当てて説明するようにしています。
ですから、この本を読むと落とし穴をよけつつ書き始めることができるのではないかと思っています。


また、もうひとつねらいがあります。
Sphinx は多くの人が興味を持ってくれるのですが、
よく耳にするのが「自分で使う分にはいいが、同僚が使ってくれなくて…」という声です。
ドキュメントは他の人と情報を共有し、プロジェクトに関わる人全員で書き換えていくようなものですから、
いくら便利なツールだとしても他の人が使えないツールでは意味がありません。

そこで 「Sphinx をはじめよう」はもうひとつの目的として、「チームメンバーに読んでもらう本」を目指しています。
Sphinx や reST に慣れていない同僚にこの本を渡すことで Sphinx をチーム内で使えるようになるかもしれません。*2

ぼやき

ブログや twitter でだらだらやってるのと比べると、本を書くとなると日本語むずかしいなあと感じますね。
表現とか書きっぷり(レベル感)ってのはなるべく意識していたつもりですが、
なかなか思うようにいかないものです。

あとチームで本を書くというのもはじめての経験で苦労しました。
お互い忙しいタイミングが違っていたりして、もどかしかったり申し訳なかったり大変でした。

しばらく書籍ばかりかまっていてコードを書く時間が取れていなかったので、
秋の夜長にゆっくりコードを書くことにします。

*1:既にリリースから 1ヶ月も経っていますね…

*2:電子書籍なので貸し借りしづらいのが難点ではあるのですが…