ドキュメントを作りたくなってしまう魔法のツールSphinx

1. UNIX 2010 12 Sphinx-‐users.jp

2.     id : ymotongpoo     OSS   Tornado Web   Redis KVS   Jinja2

3. Twitter: @shibukawa     SE       SphinxUsers.jp     XP   Ruby   Python ( )   11/14 Python Hack-‐a-‐thon     IT ( )   Python (   ( R&D) : web

4. http:// .jp/ @shimizukawa   :   Sphinx-‐users.jp   Zope/Plone   , pyspa , XP   :   Python, Rails, C++/C/8086   :   Python/Rails     Python     B5 416

5. 3  

6.     100%   sphinx-‐user.jp       http://sphinx-‐users.jp/example.html   http://sphinx.pocoo.org/examples.html

7.   1.  Sphinx 2.  Sphinx 3.  reST 4.  Sphinx      

8. 1/4 Sphinx   2     Python, easy_install, Sphinx 3     Ubuntu $ sudo apt-‐get install python-‐sphinx   Mac OS X $ sudo port install python-‐sphinx  

9. 2/4 Sphinx   “sphinx-‐quickstart” $ mkdir Unix-‐How-‐to $ cd Unix-‐How-‐to $ sphinx-‐quickstart   Enter .   conf.py   3      

10. 3/4 reST   reST = reStructuredText   http://sphinx-‐users.jp/doc10/rest.html ============   ============     =========     -‐-‐-‐-‐-‐-‐-‐-‐-‐-‐-‐-‐-‐ -‐  1   toctree -‐  2 #. 1 #. 2

11. 4/4 Sphinx   Makeﬁle $ make html ============ ============ ========= 1 2 -‐  1 1. 1 -‐  2 2. 2 #. 1 #. 2

12. 1/2   HTML LaTeX PDF ePub $ make latex $ make latexpdf $ make epub   HTML

13.   “Jinja2”   2 html   : layout.html   : page.html   basic

14. Sphinx   OSS   Python 2.6.2   OpenPNE Web API   groonga …  

15. Sphinx   Sphinx   Python & (Erlang, Ruby, C++, JavaScript…)   ) C c:function:: int printf(const char *format, …) ..

16. Sphinx         Sphinx

17. Sphinx   autodoc – docstring   intersphinx – Sphinx   pngmath – PNG   jsmath – JavaScript   graphviz – Graphviz   coverage –   todo – Todo Sphinx

18. Sphinx     sdedit   UML   blockdiag     docx   Sphinx Word

19. sdedit (Quick Sequence Deiagram Editor)   UML .. sequence-‐diagram:: :maxwidth: 500 :linewrap: false :threadnumber: true actor:Actor sphinx:Sphinx[a] dot:Graphviz sdedit:Quick Sequence Diagram Editor actor:sphinx.make html sphinx:dot.render_diagram() sphinx:sdedit.render_diagram()

20. blockdiag by @tk0miya     sphinxcontrib-‐blockdiag Sphinx .. blockdiag:: diagram webapp { login -‐> something -‐> logout -‐> login }

21. docx   Sphinx Word   by

22.   Sphinx              

23.     Word     OpenOﬃce Writer Microsoft Oﬃce

24.     Excel   Calc Microsoft Oﬃce

25.     PowerPoint   KeyNote   OpenOﬃce Impress

26.     Wiki   HTML   TeX

27. http://www.flickr.com/photos/boothy/26461481/ http://www.flickr.com/photos/omeyamapyonta/ CC BY-‐NC by Dr Snafu 3052096093/ CC BY-‐SA by PYONKO Word Excel Wiki Sphinx http://www.flickr.com/photos/johncarleton/2367673332/ http://www.flickr.com/photos/stompy/11300916/ CC BY-‐ CC BY-‐NC-‐SA by John Carleton NC by Abizern

28. Word -‐ pros         etc… http://www.ﬂickr.com/photos/jetalone/861945664/ CC BY by jetalone

29. Word -‐ cons   1       http://www.ﬂickr.com/photos/jetalone/861945664/ CC BY by jetalone

30. Excel -‐ pros   Excel     http://www.ﬂickr.com/photos/ 21183810@N00/4366518191/ CC BY-‐NC-‐SA by Jerome Rothermund

31. Excel -‐ cons     http://www.ﬂickr.com/photos/ 21183810@N00/4366518191/ CC BY-‐NC-‐SA by Jerome Rothermund

32. Wiki -‐ pros       http://www.ﬂickr.com/photos/ 7506006@N07/1197395511/ CC BY-‐NC-‐ND by milky.way

33. Wiki -‐ cons     Wikipedia     http://www.ﬂickr.com/photos/ 7506006@N07/1197395511/ CC BY-‐NC-‐ND by milky.way

34. Sphinx -‐ pros         OK http://www.ﬂickr.com/photos/ 18261299@N00/4472408386/ CC BY-‐SA by sweet_redbird

35. Sphinx -‐ cons       WYSIWIG http://www.ﬂickr.com/photos/ 18261299@N00/4472408386/ CC BY-‐SA by sweet_redbird

36.     toctree toctree toctree    

37.     #, *, =, -‐, ^, ~, “     H1, H2, H3..  

38.   Sphinx   toctree                      

39.     toctree 1   toctree toctree Sphinx

40.  

41.   •  •  + (UNIX ) •  ( ) • 

42.   ( )   .. _ : :ref:` ` .. module:: :mod:` ` .. function:: :func:` ` .. class:: :class:` ` .. method:: :meth:` ` .. attr:: :attr:` ` berrymq.talk ( )! "

43.            

44. •  • 

46. 40% 60%

47.                    

48. ω `)

49.                 ..

50. 1.  2.  3.  4. 

52. 7 1.  2.  3.  4.  5.  6.  7.  Python 10 10 :

53. APPENDIX

54.      

55. 3 JUS

56. Step1 Sphinx C:> sphinx-‐quickstart

57. Step2  

58. Step3  

59. Step4

62. Python

65. XP 2010 http:// .jp/docs/xpfest2010/

66. Python 10 10 :

67. 1.    2.    3.    4.   

68. (´ ω `)

ドキュメントを作りたくなってしまう魔法のツールSphinx

You are reading a preview.

ドキュメントを作りたくなってしまう魔法のツールSphinx

More Related Content

More from Takayuki Shimizukawa

Featured

Related Books

Related Audiobooks