Presentation detail is hereWriting a BookUsing Sphinx    2012/9/16SphinxCon JP 2012
Who am I?http://清水川.jp/ @shimizukawa●   BeProud Corp.●   Expert Python Programming    translator into Japanese●   Sphinx-u...
Python Professional Programming●   Publisher: Shuwa System●   Size: B5, 430 pages●   2940 JPY●   2012-3-27call it #pypro
Fortunately, a lot of sellingOur editor has sold the #pypro on PyConJP.However, many people had alreadypurchased.
Books concept● BPStyle (BeProud style):  The book tell BP has been cultivated in  the practice, the know-how of Python at ...
Table of Contents4 parts, 15 chapters1.   Lets develop with Python2.   Cycle of team development3.   Publish service4.   T...
Part 1: Lets develop with PythonChapter 1: Lets start PythonChapter 2: Create a Web applicationAppendix A: VirtualBox setu...
Part 2: Cycle of team developmentChapter 3: Create an environment of teamdevelopmentChapter 4: Prepare the foundation for ...
Part 3: Publish serviceChapter 10: Automated environment to build and deployChapter 11: Improve the performance of applica...
Authors1. tell-k: Chap 1,12,   Appendix A, B2. Okano: Chap 2,8,11,153. aita: Chap 3             8. (aodag): Chap 64. Shimi...
PyPro book was written by Sphinx● Sphinx = Documentation tool  http://sphinx-users.jp/
Build a writing environmentautomatically using SphinxFirst:   $ hg clone [repos-of-pypro] pypro   $ cd pypro   $ python bo...
Convert process of Sphinx        reST(reStrucutrdText)                     Docutils parser          docutils node tree    ...
Writing and Review● Write by reST● HTML Review by office-member● PDF Review by outer-geeksProvide different formats for di...
Submission format for Editorprocess: Writer -> Editor -> Print● [Editor -> Print]   maybe InDesign or else.● [Writer -> Ed...
Rewrite manually for submission?● We wrote draft with Sphinx(reST)● Submission format is different● But, we cant write sub...
I created Shuwa-Builder for Sphinx● Shuwa-builder generate shuwa-system  submission format from sphinx.       Shuwa-System
Generate manuscript for ShuwaGenerate submission formatted manuscriptfor Shuwa-System:   $ make shuwaThats all.   $ ls _bu...
Spent over 2 days to create theShuwa-builder● I took a lot of time to create the bulider.● But monotonous repetitive work ...
ConclusionWhat went wrong● auto-generation of submission manuscript needs  explicit spec.● consider how to diff-incorporat...
Upcoming SlideShare
Loading in...5
×

Writing a book using sphinx #sphinxconjp 2012

1,458

Published on

Japanese version. http://www.slideshare.net/shimizukawa/sphinx-pyconjp-2012

I will introduce the procedure and its benefits, such as when the book was written from the experience of translation and my past two books, to automate the writing environment to leverage the Sphinx.

Video of the announcement is here: http://www.youtube.com/watch?v=7VOJpFHnPWg

Published in: Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total Views
1,458
On Slideshare
0
From Embeds
0
Number of Embeds
4
Actions
Shares
0
Downloads
4
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Writing a book using sphinx #sphinxconjp 2012

  1. 1. Presentation detail is hereWriting a BookUsing Sphinx 2012/9/16SphinxCon JP 2012
  2. 2. Who am I?http://清水川.jp/ @shimizukawa● BeProud Corp.● Expert Python Programming translator into Japanese● Sphinx-users.jp vice-chairman● PyConJP 2011,2012 vice-chairman
  3. 3. Python Professional Programming● Publisher: Shuwa System● Size: B5, 430 pages● 2940 JPY● 2012-3-27call it #pypro
  4. 4. Fortunately, a lot of sellingOur editor has sold the #pypro on PyConJP.However, many people had alreadypurchased.
  5. 5. Books concept● BPStyle (BeProud style): The book tell BP has been cultivated in the practice, the know-how of Python at work.● for BP newbe: The book for work early to get accustomed to the new members of the company.
  6. 6. Table of Contents4 parts, 15 chapters1. Lets develop with Python2. Cycle of team development3. Publish service4. Technique to accelerate the development
  7. 7. Part 1: Lets develop with PythonChapter 1: Lets start PythonChapter 2: Create a Web applicationAppendix A: VirtualBox setupAppendix B: OS(Ubuntu) setup
  8. 8. Part 2: Cycle of team developmentChapter 3: Create an environment of teamdevelopmentChapter 4: Prepare the foundation for documentChapter 5: Review and issue managementChapter 6: Design of module division and unittestingChapter 7: Automated packaging and environmentsetupChapter 8: Source Code Management withMercurialChapter 9: Continuous Integration with Jenkins
  9. 9. Part 3: Publish serviceChapter 10: Automated environment to build and deployChapter 11: Improve the performance of applicationsChapter 12: Google App EnginePart 4: Technique to accelerate thedevelopmentChapter 13: Test is our friendChapter 14: Use Django to convenientlyChapter 15: To use the handy Python module
  10. 10. Authors1. tell-k: Chap 1,12, Appendix A, B2. Okano: Chap 2,8,11,153. aita: Chap 3 8. (aodag): Chap 64. Shimizukawa: Chap 4,7 9. monjudoh: Chap 85. Imagawa Yakata: Chap 10. cactusman: Chap 5,9 96. Azuma: Chap 5,10 11. drillbits: Chap 1,127. Tomita: Chap 5 12. natsu: Chap 13 13. Ikeda: Chap 14 14. Hata: Chap 14
  11. 11. PyPro book was written by Sphinx● Sphinx = Documentation tool http://sphinx-users.jp/
  12. 12. Build a writing environmentautomatically using SphinxFirst: $ hg clone [repos-of-pypro] pypro $ cd pypro $ python bootstrap.py $ bin/buildoutbuild HTML: $ vim 04.rst #chapter 04 $ make html
  13. 13. Convert process of Sphinx reST(reStrucutrdText) Docutils parser docutils node tree Sphinx HTML writer HTML
  14. 14. Writing and Review● Write by reST● HTML Review by office-member● PDF Review by outer-geeksProvide different formats for differentpurposes.If you change the look, we now notice thatsuch wrong or strange expression that wasnot noticed until then.
  15. 15. Submission format for Editorprocess: Writer -> Editor -> Print● [Editor -> Print] maybe InDesign or else.● [Writer -> Editor] the Shuwa-System format. 5 wide square charactors -> ■■■■■Chapter 1 Lets start Python 2 wide charactors -> ▽◆ 1 wide bullet charactor -> ・Python setup 1 wide bullet charactor -> ・Mercurial setup 2 wide charactors -> △◆ 4 wide square charactors -> ■■■■01-01 Python setup
  16. 16. Rewrite manually for submission?● We wrote draft with Sphinx(reST)● Submission format is different● But, we cant write submission format. Its difficult for us :(● Then, ...how?
  17. 17. I created Shuwa-Builder for Sphinx● Shuwa-builder generate shuwa-system submission format from sphinx. Shuwa-System
  18. 18. Generate manuscript for ShuwaGenerate submission formatted manuscriptfor Shuwa-System: $ make shuwaThats all. $ ls _build/shuwa 01.txt 02.txt 03.txt 04.txt ....
  19. 19. Spent over 2 days to create theShuwa-builder● I took a lot of time to create the bulider.● But monotonous repetitive work is painful to me.● I will submit several times until publication. I will get a return on that investment.shortly afterward, I applying proveddifference to original reST draft :(3rd proof paper was PDF format. How do Icheck diff?
  20. 20. ConclusionWhat went wrong● auto-generation of submission manuscript needs explicit spec.● consider how to diff-incorporationWhat worked● Written in text that easy to writing and manage differential● Review need differencial look● To automate the preparation of environmental● At any time to provide the latest HTML and PDF ○ that is provided by Jenkins at commit&push to the repository.

×