Sphinxを使って本を書こう #pyconjp 2012
Upcoming SlideShare
Loading in...5
×
 

Sphinxを使って本を書こう #pyconjp 2012

on

  • 2,730 views

English version is here: https://www.slideshare.net/shimizukawa/writing-a-book-using-sphinx-sphinxconjp-2012 ...

English version is here: https://www.slideshare.net/shimizukawa/writing-a-book-using-sphinx-sphinxconjp-2012

私の過去2冊の翻訳・執筆した本の経験から、Sphinxを活用して執筆環境を自動化したときの手順とそのメリットなどを紹介します。

発表時の動画はこちら: http://www.youtube.com/watch?v=7VOJpFHnPWg

Statistics

Views

Total Views
2,730
Views on SlideShare
2,174
Embed Views
556

Actions

Likes
6
Downloads
1
Comments
0

3 Embeds 556

http://cointoss.hatenablog.com 526
https://twitter.com 27
http://webcache.googleusercontent.com 3

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

Sphinxを使って本を書こう #pyconjp 2012 Sphinxを使って本を書こう #pyconjp 2012 Presentation Transcript

  • Sphinxを使って本を書こう 2012/9/16 PyCon JP 2012
  • おまえ誰よ (a.k.a. 自己紹介)http://清水川.jp/ @shimizukawa● 株式会社BeProud所属● エキスパートPythonプログラミング の翻訳(4名で)● Sphinx-users.jp 副会長● PyConJP 2011,2012 副座長
  • Pythonプロフェッショナルプログラミング● 秀和システム刊● B5変(430ページ)● 2940円● 2012年3月27日(火)#pypro View slide
  • おかげさまで売れてるみたいです担当編集さんがPyConJPに販売に来てくれましたが、みんな持ってたとか・・・ View slide
  • 本のコンセプト● BPStyle: BPが実践で培ってきた、仕事でのPythonの ノウハウを伝える本● BP新人向け: 新しい会社のメンバーに早く仕事に慣れても らうための本
  • 目次4部構成1. Pythonで開発しよう2. チーム開発のサイクル3. サービス公開4. 開発を加速するテクニック
  • 第1部:Pythonで開発しよう第1章:Pythonを始めよう第2章:Webアプリケーションを作るAppendix A: VirtualBoxのセットアップAppendix B: OS(Ubuntu)のセットアップ
  • 第2部:チーム開発のサイクル第3章:チームの開発環境を整える第4章:ドキュメントの基盤を整える第5章:課題管理とレビュー第6章:モジュール分割設計と単体テスト第7章:パッケージングと環境セットアップの自動化第8章:Mercurialによるソースコード管理第9章:Jenkinsで継続的インテグレーション
  • 第3部:サービス公開第10章:環境構築とデプロイの自動化第11章:アプリケーションのパフォーマンス改善第12章:Google App Engine第4部:開発を加速するテクニック第13章:テストを味方にする第14章:Djangoを便利に使う第15章:便利なPythonモジュールを使おう
  • 執筆者一覧1. tell-k: 1章, 12章, 7. 冨田: 5章 AppendiA,B 8. (あお): 6章2. 岡野: 2章, 8章, 11章, 9. 文殊堂: 8章 15章 10. cactusman: 9章3. aita: 3章 11. drillbits: 1章, 12章4. 清水川: 4章, 7章 12. ナツ: 13章5. 今川館: 5章, 9章 13. 池田: 14章6. 東: 5章, 10章 14. 畠: 14章
  • この本の原稿はSphinxで書きました● Sphinx = ドキュメンテーションツール http://sphinx-users.jp/
  • Sphinx執筆環境構築を自動構築初回: $ hg clone [bpbookのリポジトリ] bpbook $ cd bpbook $ python bootstrap.py $ bin/buildoutHTML生成: $ vim 04.rst $ make html
  • Sphinxの変換の仕組み reST(reStrucutrdText)を用意 docutilsノードツリーに変換 HTML等に変換
  • 執筆とレビュー● 執筆はreST● 社内レビューはHTML● 社外レビューはPDF目的別に異なるフォーマットで閲覧。見た目を変えると、気づかなかった誤記やおかしな表現などに気づけるようになる。
  • 原稿の提出フォーマット● [編集さん -> 印刷] たぶんInDesignか何か● [執筆者 -> 編集さん] 秀和システムさんのフォーマット ■■■■■Chapter 1 Pythonをはじめよう ▽◆ ・Pythonのセットアップ ・Mercurialのセットアップ △◆ ■■■■01-01 Pythonのセットアップ
  • 提出用に手動で書き直す?● 原稿はSphinx(reST)で書いた● 提出用フォーマットは書式が違う● 提出フォーマットで初めから書くのは厳しい● どうする?
  • Sphinxの秀和ビルダーを作った● 秀和システムさんの原稿フォーマットを出力し ました
  • 提出原稿をSphinxから生成秀和システム提出原稿生成: $ make syuwaこれだけ。 $ ls _build/syuwa 01.txt 02.txt 03.txt 04.txt ....
  • 秀和ビルダー作るのに丸2日以上● ビルダー作成に時間がかかってしまった● でも、刺身たんぽぽ作業はツライ● 今後3,4回くらい提出するから元は取れる!戻ってきた校正原稿差分をreSTに戻すのに、また2日かかってしまった(´;ω;` )3回目以降は書籍PDFに注釈で提出(´;ω;` )
  • まとめうまくいかなかったこと● 提出原稿の自動生成は明確な仕様が必要● 戻り原稿の受け取り方も考えておこううまくいったこと● 編集と差分管理しやすいテキストで書く● レビューは別のビューで行う● (Sphinx等)環境用意は自動化しておく● いつでも最新のHTML, PDFを提供する ○ →リポジトリコミット→Jenkinsでmake