how to spread rest and sphinx
DESCRIPTION
How do I spread reStructuredText and Sphinx to my project team.TRANSCRIPT
![Page 1: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/1.jpg)
How to spreadreST and Sphinx
2012-09-16 Sphinx Con JP 2012(#sphinxconjp)Takanori Suzuki(@takanory)
![Page 2: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/2.jpg)
Who am I(お前誰よ)
• 鈴木 たかのり/ Takanori Suzuki
• Twitter: @takanory
• http://takanory.net/
• PyCon JP 2011, 2012 Staff
• Python mini Hack-a-thon(#pyhack)
• Python Bouldering Club(#kabepy)
![Page 3: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/3.jpg)
Story
• Motivation
• 1st step: reStructuredText
• 2nd step: Plone + reStructuredText
• 3rd step: Sphinx
![Page 4: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/4.jpg)
Motivation
• MS-Word使いたくない / I hate MS-Word
• らくしたい / I hate routine work
• reStructuredTextで書きたい / I like reST
![Page 5: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/5.jpg)
reStructuredText
![Page 6: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/6.jpg)
reStructuredText
• 1st step
• 議事録を書く / Write minutes
• メールに添付 / Attach to email
• なんとなく読める / Readable
![Page 7: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/7.jpg)
reStructuredText
![Page 8: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/8.jpg)
reStructuredText
• reStructuredText がなんとなく読めるようになる / Somehow read
• 同じフォーマットで書く人が出てくる / Followers come out
![Page 9: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/9.jpg)
Plone + reST
![Page 10: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/10.jpg)
Plone + reST
• 2nd step
• 議事録を書く / Write minutes
• サイトにアップ / Site upload
• 週報を書く / Write weekly reports
• 相互に書き込み / Collaboration
![Page 11: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/11.jpg)
Plone + reST
• Plone
• Python based CMS
• reStructuredText format support
![Page 12: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/12.jpg)
Plone + reST
![Page 13: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/13.jpg)
Plone + reST
![Page 14: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/14.jpg)
Plone + reST
• 普段からreSTを使うようになる /
Everyday use reST
• 楽しく書く / Fun writing
• 他の人を真似する / Imitate others
![Page 15: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/15.jpg)
Sphinx
![Page 16: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/16.jpg)
Sphinx
• 3rd step
• チームで資料を書く / Team writing
• 書くことに集中 / Focus on writing
• 設定したい人は使えるようにする /
Installation instructions
![Page 17: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/17.jpg)
チームでドキュメントTeam writing
• Sphinx のファイル構成を全部作る / I
made document structure
• タイトルと担当者をすべて入れる / I fill
in all titles and all authors
• 目次だけできている状態 / Table of
contents completed
![Page 18: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/18.jpg)
書くことに集中Focus on writing
• ファイルはバージョン管理 / use Version
Control System
• サーバでbuildしてみんなが読める /
build on Server
• sphinx環境不要 / Do not need sphinx
![Page 19: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/19.jpg)
使えるようにするInstallation instructions
• インストール手順を書く / Installation
document
• conf.py で環境による条件分岐 /
eliminate environment-dependent
• Windows / Linux / Mac
• blockdiag / seqdiag
![Page 20: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/20.jpg)
Sphinx
• みんなでドキュメントが作れた !! / We
build specification document !!
![Page 21: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/21.jpg)
Summary
• 徐々に広める / little by little spread
• 書くことに集中 / Focus on writing
• 最後は自分で面倒をみる / Take care of
overall
![Page 22: How to spread reST and Sphinx](https://reader033.vdocuments.net/reader033/viewer/2022042601/5481291a5906b5f56c8b461c/html5/thumbnails/22.jpg)
Happy writing!