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

53,553 views

Published on

http://sphinx-users.jp/event/20101203_jus_benkyoukai.html

日本UNIXユーザ会 2010年12月勉強会 (2010/12/3)
日本UNIXユーザ会の2010年12月の勉強会にて、以下の内容で発表させていただきました。

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

Published in: Technology

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

  1. 1. UNIX 2010 12     Sphinx-­‐users.jp    
  2. 2.       id  :  ymotongpoo        OSS     Tornado   Web     Redis   KVS     Jinja2      
  3. 3. Twitter:  @shibukawa       SE            SphinxUsers.jp         XP     Ruby     Python ( )     11/14 Python  Hack-­‐a-­‐thon        IT   ( )     Python   (     ( R&D)   :   web
  4. 4. http:// .jp/      @shimizukawa    :     Sphinx-­‐users.jp       Zope/Plone       ,  pyspa ,    XP   :     Python,  Rails,   C++/C/8086    :     Python/Rails        Python       B5  416
  5. 5. 3    
  6. 6.      100%     sphinx-­‐user.jp            http://sphinx-­‐users.jp/example.html      http://sphinx.pocoo.org/examples.html  
  7. 7.     1.  Sphinx   2.  Sphinx   3.  reST   4.  Sphinx           
  8. 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. 9. 2/4  Sphinx   “sphinx-­‐quickstart”   $  mkdir  Unix-­‐How-­‐to   $  cd  Unix-­‐How-­‐to     $  sphinx-­‐quickstart   Enter    .         conf.py            3                            
  10. 10. 3/4  reST   reST  =  reStructuredText     http://sphinx-­‐users.jp/doc10/rest.html   ============        ============             =========             -­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐   -­‐  1    toctree   -­‐  2      #.   1      #.   2
  11. 11. 4/4  Sphinx   Makefile $  make  html ============       ============       =========   1   2   -­‐  1        1.   1   -­‐  2        2.   2    #.   1      #.   2
  12. 12.  1/2   HTML LaTeX PDF   ePub   $  make  latex   $  make  latexpdf     $  make  epub   HTML  
  13. 13.    “Jinja2”     2 html      :  layout.html      :  page.html     basic    
  14. 14. Sphinx   OSS     Python  2.6.2     OpenPNE  Web  API     groonga …     
  15. 15. Sphinx   Sphinx     Python &    (Erlang,  Ruby,  C++,  JavaScript…)       )    C   c:function::  int  printf(const  char  *format,  …) ..  
  16. 16. Sphinx              Sphinx    
  17. 17. Sphinx   autodoc  –  docstring      intersphinx  –   Sphinx    pngmath  –   PNG    jsmath  –  JavaScript    graphviz  –  Graphviz    coverage  –      todo  –  Todo   Sphinx  
  18. 18. Sphinx       sdedit     UML     blockdiag         docx     Sphinx Word  
  19. 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. 20. blockdiag  by  @tk0miya      sphinxcontrib-­‐blockdiag   Sphinx   ..  blockdiag::          diagram  webapp  {                  login  -­‐>  something  -­‐>  logout  -­‐>  login              }
  21. 21. docx   Sphinx Word     by    
  22. 22.   Sphinx                              
  23. 23.         Word         OpenOffice  Writer Microsoft Office  
  24. 24.        Excel     Calc   Microsoft Office  
  25. 25.        PowerPoint     KeyNote     OpenOffice  Impress  
  26. 26.        Wiki     HTML     TeX  
  27. 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. 28. Word  -­‐  pros                 etc…  http://www.flickr.com/photos/jetalone/861945664/  CC  BY  by  jetalone
  29. 29. Word  -­‐  cons   1             http://www.flickr.com/photos/jetalone/861945664/  CC  BY  by  jetalone
  30. 30. Excel  -­‐  pros   Excel         http://www.flickr.com/photos/ 21183810@N00/4366518191/  CC  BY-­‐NC-­‐SA  by  Jerome   Rothermund
  31. 31. Excel  -­‐  cons      http://www.flickr.com/photos/ 21183810@N00/4366518191/  CC  BY-­‐NC-­‐SA  by  Jerome   Rothermund
  32. 32. Wiki  -­‐  pros            http://www.flickr.com/photos/7506006@N07/1197395511/  CC  BY-­‐NC-­‐ND  by  milky.way
  33. 33. Wiki  -­‐  cons       Wikipedia         http://www.flickr.com/photos/7506006@N07/1197395511/  CC  BY-­‐NC-­‐ND  by  milky.way
  34. 34. Sphinx  -­‐  pros             OK http://www.flickr.com/photos/ 18261299@N00/4472408386/  CC  BY-­‐SA  by  sweet_redbird
  35. 35. Sphinx  -­‐  cons         WYSIWIG http://www.flickr.com/photos/ 18261299@N00/4472408386/  CC  BY-­‐SA  by  sweet_redbird
  36. 36.       toctree toctree toctree       
  37. 37.      #,  *,  =,  -­‐,  ^,  ~,  “        H1,  H2,  H3..   
  38. 38.   Sphinx    toctree                                                              
  39. 39.      toctree 1    toctree toctree Sphinx
  40. 40.  
  41. 41.   •    •  + (UNIX )   •  ( )   • 
  42. 42.   ( )     ..  _ : :ref:` ` ..  module::   :mod:` ` ..  function::   :func:` ` ..  class::   :class:` ` ..  method::   :meth:` ` ..  attr::   :attr:` ` berrymq.talk ( )! "
  43. 43.                      
  44. 44.  •   • 
  45. 45.  
  46. 46. 40% 60%  
  47. 47.                              
  48. 48. ω `)
  49. 49.                          ..
  50. 50. 1.   2.     3.   4.   
  51. 51.  
  52. 52. 7  1.   2.   3.   4.   5.  6.  7.    Python 10 10 :
  53. 53.          APPENDIX  
  54. 54.                
  55. 55. 3 JUS
  56. 56. Step1  Sphinx C:>  sphinx-­‐quickstart
  57. 57. Step2    
  58. 58. Step3      
  59. 59. Step4      
  60. 60.    
  61. 61.  
  62. 62. Python
  63. 63.  
  64. 64.  
  65. 65. XP 2010http:// .jp/docs/xpfest2010/          
  66. 66. Python 1010 :
  67. 67. 1.       2.       3.       4.     
  68. 68. (´ ω `)  

×