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

Takayuki Shimizukawa
Takayuki ShimizukawaWeb Developer at BePROUD Inc.
UNIX   	
 2010 12    	
  




                            Sphinx-­‐users.jp	
  
                                                	
  
                                        	
  
  	
  id	
  :	
  ymotongpoo	
  
                                        	
  

  OSS                                                 	
  
     Tornado	
                Web                     	
  
     Redis	
                 KVS 	
  
     Jinja2	
                                  	
  
         	
  
Twitter:	
  @shibukawa	
 
              	
  
                                                             SE	
  
                                                                                                       	
  
                                                      	
  
       SphinxUsers.jp                                          	
  
                                                                                                	
  
           XP                                                               	
  
             Ruby	
  
       Python    (                            )	
  
                     11/14 Python	
  Hack-­‐a-­‐thon	
  
                                       	
  
       IT                                                                                	
  
                                                   (                                 )	
  
                                              Python                                                    	
  
          (                                                                   	
  
      
                  (                            R&D)	
  
                                :	
             web
http://                            .jp/	
  	
  	
  @shimizukawa	
  
                                                                 :	
  
       Sphinx-­‐users.jp	
                  	
  
       Zope/Plone	
          	
  
             ,	
  pyspa ,	
  	
  XP         	
 
              :	
  
       Python,	
  Rails,	
              C++/C/8086	
  
              :	
  
                             Python/Rails                 	
  
                      	
  
                                 Python                          	
 
                                                   	
  
               B5 	
  416
ドキュメントを作りたくなってしまう魔法のツールSphinx
3   	
 
              	
  
                                                                	
  
                          100%                         	
  
       sphinx-­‐user.jp	
  
                                   	
  
                          	
  
                	
  http://sphinx-­‐users.jp/example.html	
  
                	
  http://sphinx.pocoo.org/examples.html	
  
ドキュメントを作りたくなってしまう魔法のツールSphinx
          	
  
     1.  Sphinx                 	
  
     2.  Sphinx                        	
  
     3.  reST                                 	
  
     4.  Sphinx                                             	
  
                                                    	
  
                 	
  
                        	
  
1/4	
  Sphinx                                                       	
  2                                               	
  

                            	
  
       Python,	
  easy_install,	
  Sphinx                           3               	
  
                                                                             	
  
              Ubuntu	
  
                $	
  sudo	
  apt-­‐get	
  install	
  python-­‐sphinx	
  	
 

              Mac	
  OS	
  X	
  
                $	
  sudo	
  port	
  install	
  python-­‐sphinx	
 


                                   	
  
2/4	
  Sphinx                                                                     	
  “sphinx-­‐quickstart”                                          	
  
          $	
  mkdir	
  Unix-­‐How-­‐to	
  
          $	
  cd	
  Unix-­‐How-­‐to	
  	
  
          $	
  sphinx-­‐quickstart	
 


                              Enter                      	
             	
  .	
  
                                                                                     	
                       	
  
       conf.py                                                  	
                  	
          	
  
                                                                                     	
             	
  
           3                                      	
                                	
                                    	
  
                                      	
                                            	
                	
  
                                                                                     	
                          	
  
                                      	
                                            	
                             	
  
      
3/4	
  reST                                                                      	
  reST	
  =	
  reStructuredText	
  
      http://sphinx-­‐users.jp/doc10/rest.html	
  
                                                                                                             	
                                                           ============	
  
                                            	
                   	
  
                                                           ============	
  
                  	
  
                                                   	
            	
  
                                                           =========	
  
                                     	
  
                                                                                             	
  
           	
  
                                                           -­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐	
  

                                                           -­‐                                           1	
  
  toctree                     	
                          -­‐                                           2	
  
                                                           	
  	
  #.	
                                           1	
  
                                                           	
  	
  #.	
                                           2
4/4	
  Sphinx                                                                                	
                                              Makefile                                                           	
 
                        $	
  make	
  html	
 




     ============	
  
                                                         	
            	
                                                                            	
  
     ============	
  
                                                                                   	
  
          	
  
     =========	
                                                                                 1	
  
                                                                                                 2	
  
     -­‐                            1	
                       	
  	
  	
  1.	
                           1	
  
     -­‐                            2	
                       	
  	
  	
  2.	
                           2	
 
     	
  	
  #.	
                           1	
  
     	
  	
  #.	
                           2
 1/2	
  HTML                             LaTeX   PDF	
   ePub    	
  
    $	
  make	
  latex	
  
    $	
  make	
  latexpdf	
  	
  
    $	
  make	
  epub	
 


  HTML                                            	
  
                                  	
  “Jinja2”                      	
  


                                                                       	
 
                  2           html                           	
  
                                       	
  :	
  layout.html	
  
         	
  :	
  page.html	
  

                       	
  basic	
  
          	
  
Sphinx                   	
            OSS                                                	
  
       Python	
  2.6.2                  	
  
       OpenPNE	
  Web	
  API              	
  
       groonga                      …            	
  

                                                        	
  
Sphinx                                 	
                                                                                 Sphinx
                                          	
  
       Python                                                              &               	
  
          	
  (Erlang,	
  Ruby,	
  C++,	
  JavaScript…)	
  
                                                                          	
  

          )	
  	
  C	
   c:function::	
  int	
  printf(const	
  char	
  *format,	
  …)	
 
                    ..	
  
Sphinx   	
                                           	
  
                                 	
  
                          	
  

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

                                   Sphinx                    	
  
Sphinx           	
                                  	
  
       sdedit	
  
            UML            	
  
       blockdiag	
  
                                                   	
  
       docx	
  
          Sphinx    Word                    	
  
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()	
  
blockdiag	
  by	
  @tk0miya	
                                                                                                                  	
  
  sphinxcontrib-­‐blockdiag	
                                              Sphinx
                                              	
  

           ..	
  blockdiag::	
  

           	
  	
  	
  	
  diagram	
  webapp	
  {	
  
           	
  	
  	
  	
  	
  	
  	
  	
  login	
  -­‐>	
  something	
  -­‐>	
  logout	
  -­‐>	
  login	
  	
  	
  
           	
  	
  	
  	
  }
docx	
  Sphinx     Word                   	
  

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




       Microsoft   Office 	
  
 
              	
  
       Excel	
  
       Calc	
  




          Microsoft          Office 	
  
 
                            	
  
       PowerPoint	
  
       KeyNote	
  
       OpenOffice	
  Impress	
  
 
                         	
  
       Wiki	
  
       HTML                     	
  
       TeX	
  
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
Word	
  -­‐	
  pros	
                                              	
  
                                                     	
  
                                              	
  
                                     	
  
                                  etc…	
  




http://www.flickr.com/photos/jetalone/861945664/	
  
CC	
  BY	
  by	
  jetalone
Word	
  -­‐	
  cons	
                    1                                 	
  
                                    	
  
                                               	
  
                                                             	
 




http://www.flickr.com/photos/jetalone/861945664/	
  
CC	
  BY	
  by	
  jetalone
Excel	
  -­‐	
  pros	
  Excel                      	
  
                                    	
  
 
                                                        	
  




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




                                    http://www.flickr.com/photos/
                                    21183810@N00/4366518191/	
  CC	
  BY-­‐NC-­‐SA	
  by	
  Jerome	
  
                                    Rothermund
Wiki	
  -­‐	
  pros	
                                        	
  
                                                                            	
  
                                                                     	
  




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




http://www.flickr.com/photos/
7506006@N07/1197395511/	
  CC	
  BY-­‐NC-­‐ND	
  by	
  milky.way
Sphinx	
  -­‐	
  pros	
                                                             	
  
                                                                       	
  
                         	
  
                                                                              OK        	
 




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




                                       http://www.flickr.com/photos/
                                       18261299@N00/4472408386/	
  CC	
  BY-­‐SA	
  by	
  sweet_redbird
ドキュメントを作りたくなってしまう魔法のツールSphinx
         	
  
       toctree   toctree toctree 	
  
                           	
  
      
                                                         	
  
  #,	
  *,	
  =,	
  -­‐,	
  ^,	
  ~,	
  “                                                      	
  
                                                                      	
  
                                            H1,	
  H2,	
  H3..                          	
  
 
  Sphinx                                      	
  
  toctree                                                                                  	
  
                                                                              	
  
                                                     	
  



 	
  	
               	
                                      	
               	
  
 	
 	
 	
 	
             	
  	
                                        	
                                	
  
                                                                       	
                                       	
  
                                                                       	
                                              	
  
 	
 	
 	
 	
    	
 
                                                              	
                                  	
  
 	
 	
 	
 	
                       	
                                  	
                                       	
  
 	
 	
 	
 	
                             	
                            	
                                	
  
                                                                       	
                                              	
  
                                                                       	
  
 
                   	
  
  toctree          1       	
  
  toctree
             	
 




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




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

                                            	
                	
                                                          	
               	
 
       ..	
  _         :	
                        :ref:`             `	
           ..	
  module::	
                       	
  :mod:`              `	
 
       ..	
  function::	
                    	
  :func:`                `	
        ..	
  class::	
              	
              :class:`           `	
 
       ..	
  method::	
                    	
  :meth:`                      `	
    ..	
  attr::	
             	
                :attr:`          `	
 

 	
  	
                        	
                 	
                               berrymq.talk                     (                 )!
 	
  	
                              	
                        	
                                                                          "
                	
  
                       	
  
                                    	
  
         	
  
                	
  
      
 
•                 	
  
• 
 
40%

                       	
 
60%	
  
 

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

                              	
                                         	
 

                                    	
  
                                             
                                                              	
  
 
             	
                              
                                                 	
  


     ..
1.                       	
  

2. 
      	
  
                  	
  

3.                       	
  

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

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

                               10 :
 
    	
 


                	
  
         	
  
         	
  
         	
  
APPENDIX	
  
                         	
  
     	
  

                                	
  
            	
  

                         	
  
                   	
  
3   JUS
Step1	
  Sphinx              	

C:>	
  sphinx-­‐quickstart
Step2	
     	

 
Step3	
           	
 
       	
  
Step4	
                   	


                   	
  
            	
  
 



	
  
 
Python
 
 
XP           2010

http://               .jp/docs/xpfest2010/


                                                      	
  
                                                	
 
               	
                   	
 

                         	
                                                           	
  
                                                                                             	
 


                                          	
                 	
 




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

10 :
1.                                  	
  
                            	
  

2. 
           	
  
                            	
  

3.                                  	
  
                                          	
  

4.                                                	
  
       
(´ ω `) 	




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

Recommended

AWSではじめるMLOps by
AWSではじめるMLOpsAWSではじめるMLOps
AWSではじめるMLOpsMariOhbuchi
3.2K views50 slides
入門 Kubeflow ~Kubernetesで機械学習をはじめるために~ (NTT Tech Conference #4 講演資料) by
入門 Kubeflow ~Kubernetesで機械学習をはじめるために~ (NTT Tech Conference #4 講演資料)入門 Kubeflow ~Kubernetesで機械学習をはじめるために~ (NTT Tech Conference #4 講演資料)
入門 Kubeflow ~Kubernetesで機械学習をはじめるために~ (NTT Tech Conference #4 講演資料)NTT DATA Technology & Innovation
5.9K views56 slides
MLOps入門 by
MLOps入門MLOps入門
MLOps入門Hiro Mura
2.1K views45 slides
エンジニアのためのOSSライセンス管理~OSS管理ツールの池の水全部抜く~ by
エンジニアのためのOSSライセンス管理~OSS管理ツールの池の水全部抜く~エンジニアのためのOSSライセンス管理~OSS管理ツールの池の水全部抜く~
エンジニアのためのOSSライセンス管理~OSS管理ツールの池の水全部抜く~Daisuke Morishita
2.3K views55 slides
それはYAGNIか? それとも思考停止か? by
それはYAGNIか? それとも思考停止か?それはYAGNIか? それとも思考停止か?
それはYAGNIか? それとも思考停止か?Yoshitaka Kawashima
29.3K views41 slides
マイクロにしすぎた結果がこれだよ! by
マイクロにしすぎた結果がこれだよ!マイクロにしすぎた結果がこれだよ!
マイクロにしすぎた結果がこれだよ!mosa siru
132.7K views32 slides

More Related Content

What's hot

WebAssemblyのWeb以外のことぜんぶ話す by
WebAssemblyのWeb以外のことぜんぶ話すWebAssemblyのWeb以外のことぜんぶ話す
WebAssemblyのWeb以外のことぜんぶ話すTakaya Saeki
28.2K views37 slides
目grep入門 +解説 by
目grep入門 +解説目grep入門 +解説
目grep入門 +解説murachue
89.4K views83 slides
開発速度が速い #とは(LayerX社内資料) by
開発速度が速い #とは(LayerX社内資料)開発速度が速い #とは(LayerX社内資料)
開発速度が速い #とは(LayerX社内資料)mosa siru
61.6K views18 slides
Python 3.9からの新定番zoneinfoを使いこなそう by
Python 3.9からの新定番zoneinfoを使いこなそうPython 3.9からの新定番zoneinfoを使いこなそう
Python 3.9からの新定番zoneinfoを使いこなそうRyuji Tsutsui
6.9K views42 slides
Data-Centric AIの紹介 by
Data-Centric AIの紹介Data-Centric AIの紹介
Data-Centric AIの紹介Kazuyuki Miyazawa
3.8K views39 slides
分散システムについて語らせてくれ by
分散システムについて語らせてくれ分散システムについて語らせてくれ
分散システムについて語らせてくれKumazaki Hiroki
119.5K views45 slides

What's hot(20)

WebAssemblyのWeb以外のことぜんぶ話す by Takaya Saeki
WebAssemblyのWeb以外のことぜんぶ話すWebAssemblyのWeb以外のことぜんぶ話す
WebAssemblyのWeb以外のことぜんぶ話す
Takaya Saeki28.2K views
目grep入門 +解説 by murachue
目grep入門 +解説目grep入門 +解説
目grep入門 +解説
murachue89.4K views
開発速度が速い #とは(LayerX社内資料) by mosa siru
開発速度が速い #とは(LayerX社内資料)開発速度が速い #とは(LayerX社内資料)
開発速度が速い #とは(LayerX社内資料)
mosa siru61.6K views
Python 3.9からの新定番zoneinfoを使いこなそう by Ryuji Tsutsui
Python 3.9からの新定番zoneinfoを使いこなそうPython 3.9からの新定番zoneinfoを使いこなそう
Python 3.9からの新定番zoneinfoを使いこなそう
Ryuji Tsutsui6.9K views
分散システムについて語らせてくれ by Kumazaki Hiroki
分散システムについて語らせてくれ分散システムについて語らせてくれ
分散システムについて語らせてくれ
Kumazaki Hiroki119.5K views
Pythonによる黒魔術入門 by 大樹 小倉
Pythonによる黒魔術入門Pythonによる黒魔術入門
Pythonによる黒魔術入門
大樹 小倉44.4K views
機械学習で泣かないためのコード設計 by Takahiro Kubo
機械学習で泣かないためのコード設計機械学習で泣かないためのコード設計
機械学習で泣かないためのコード設計
Takahiro Kubo62.3K views
エンジニアの個人ブランディングと技術組織 by Takafumi ONAKA
エンジニアの個人ブランディングと技術組織エンジニアの個人ブランディングと技術組織
エンジニアの個人ブランディングと技術組織
Takafumi ONAKA23.4K views
Kubernetesによる機械学習基盤への挑戦 by Preferred Networks
Kubernetesによる機械学習基盤への挑戦Kubernetesによる機械学習基盤への挑戦
Kubernetesによる機械学習基盤への挑戦
Preferred Networks14.6K views
5分で出来る!イケてるconfluenceページ by CLARA ONLINE, Inc.
5分で出来る!イケてるconfluenceページ5分で出来る!イケてるconfluenceページ
5分で出来る!イケてるconfluenceページ
CLARA ONLINE, Inc.78.8K views
世界一わかりやすいClean Architecture by Atsushi Nakamura
世界一わかりやすいClean Architecture世界一わかりやすいClean Architecture
世界一わかりやすいClean Architecture
Atsushi Nakamura47.2K views
例外設計における大罪 by Takuto Wada
例外設計における大罪例外設計における大罪
例外設計における大罪
Takuto Wada68.6K views
GoによるWebアプリ開発のキホン by Akihiko Horiuchi
GoによるWebアプリ開発のキホンGoによるWebアプリ開発のキホン
GoによるWebアプリ開発のキホン
Akihiko Horiuchi61K views
こわくない Git by Kota Saito
こわくない Gitこわくない Git
こわくない Git
Kota Saito881.6K views
SSII2021 [TS1] Visual SLAM ~カメラ幾何の基礎から最近の技術動向まで~ by SSII
SSII2021 [TS1] Visual SLAM ~カメラ幾何の基礎から最近の技術動向まで~SSII2021 [TS1] Visual SLAM ~カメラ幾何の基礎から最近の技術動向まで~
SSII2021 [TS1] Visual SLAM ~カメラ幾何の基礎から最近の技術動向まで~
SSII4.4K views
SQLアンチパターン 幻の第26章「とりあえず削除フラグ」 by Takuto Wada
SQLアンチパターン 幻の第26章「とりあえず削除フラグ」SQLアンチパターン 幻の第26章「とりあえず削除フラグ」
SQLアンチパターン 幻の第26章「とりあえず削除フラグ」
Takuto Wada148.7K views
君はyarn.lockをコミットしているか? by Teppei Sato
君はyarn.lockをコミットしているか?君はyarn.lockをコミットしているか?
君はyarn.lockをコミットしているか?
Teppei Sato30.5K views
Redisの特徴と活用方法について by Yuji Otani
Redisの特徴と活用方法についてRedisの特徴と活用方法について
Redisの特徴と活用方法について
Yuji Otani101.6K views
【DL輪読会】SimCSE: Simple Contrastive Learning of Sentence Embeddings (EMNLP 2021) by Deep Learning JP
【DL輪読会】SimCSE: Simple Contrastive Learning of Sentence Embeddings  (EMNLP 2021)【DL輪読会】SimCSE: Simple Contrastive Learning of Sentence Embeddings  (EMNLP 2021)
【DL輪読会】SimCSE: Simple Contrastive Learning of Sentence Embeddings (EMNLP 2021)
Deep Learning JP3.7K views

Viewers also liked

ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会 by
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会Takayuki Shimizukawa
37.8K views126 slides
こんなに使える!今どきのAPIドキュメンテーションツール by
こんなに使える!今どきのAPIドキュメンテーションツールこんなに使える!今どきのAPIドキュメンテーションツール
こんなに使える!今どきのAPIドキュメンテーションツールdcubeio
25.9K views52 slides
高卒でIT企業に入った体験談 by
高卒でIT企業に入った体験談高卒でIT企業に入った体験談
高卒でIT企業に入った体験談ishikawa_mizuki
3.1K views26 slides
怖くない? オープンソースへの貢献 by
怖くない? オープンソースへの貢献怖くない? オープンソースへの貢献
怖くない? オープンソースへの貢献ishikawa_mizuki
2.4K views32 slides
灰かぶりチケットはシンデレラに成り得るか? by
灰かぶりチケットはシンデレラに成り得るか?灰かぶりチケットはシンデレラに成り得るか?
灰かぶりチケットはシンデレラに成り得るか?ishikawa_mizuki
9.4K views22 slides
運用管理ツールに求められる、運用効率化・運用自動化の実現方式とは? by
運用管理ツールに求められる、運用効率化・運用自動化の実現方式とは?運用管理ツールに求められる、運用効率化・運用自動化の実現方式とは?
運用管理ツールに求められる、運用効率化・運用自動化の実現方式とは?Hinemos
1.5K views26 slides

Viewers also liked(20)

ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会 by Takayuki Shimizukawa
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
Takayuki Shimizukawa37.8K views
こんなに使える!今どきのAPIドキュメンテーションツール by dcubeio
こんなに使える!今どきのAPIドキュメンテーションツールこんなに使える!今どきのAPIドキュメンテーションツール
こんなに使える!今どきのAPIドキュメンテーションツール
dcubeio25.9K views
高卒でIT企業に入った体験談 by ishikawa_mizuki
高卒でIT企業に入った体験談高卒でIT企業に入った体験談
高卒でIT企業に入った体験談
ishikawa_mizuki3.1K views
怖くない? オープンソースへの貢献 by ishikawa_mizuki
怖くない? オープンソースへの貢献怖くない? オープンソースへの貢献
怖くない? オープンソースへの貢献
ishikawa_mizuki2.4K views
灰かぶりチケットはシンデレラに成り得るか? by ishikawa_mizuki
灰かぶりチケットはシンデレラに成り得るか?灰かぶりチケットはシンデレラに成り得るか?
灰かぶりチケットはシンデレラに成り得るか?
ishikawa_mizuki9.4K views
運用管理ツールに求められる、運用効率化・運用自動化の実現方式とは? by Hinemos
運用管理ツールに求められる、運用効率化・運用自動化の実現方式とは?運用管理ツールに求められる、運用効率化・運用自動化の実現方式とは?
運用管理ツールに求められる、運用効率化・運用自動化の実現方式とは?
Hinemos1.5K views
完全負け組なモバイルWebが、これから復活する(多分) by Hiroshi Kawada
完全負け組なモバイルWebが、これから復活する(多分)完全負け組なモバイルWebが、これから復活する(多分)
完全負け組なモバイルWebが、これから復活する(多分)
Hiroshi Kawada53.5K views
Funcargs & other fun with pytest by Brianna Laugher
Funcargs & other fun with pytestFuncargs & other fun with pytest
Funcargs & other fun with pytest
Brianna Laugher14K views
とある制作会社の目次索引作成技法 by Kenshi Muto
とある制作会社の目次索引作成技法とある制作会社の目次索引作成技法
とある制作会社の目次索引作成技法
Kenshi Muto12K views
Internet ExplorerはIE特化アプリから一時的に日本を救ってくれたけど次回はもう助けてくれないよという警告 by Hiroshi Kawada
Internet ExplorerはIE特化アプリから一時的に日本を救ってくれたけど次回はもう助けてくれないよという警告Internet ExplorerはIE特化アプリから一時的に日本を救ってくれたけど次回はもう助けてくれないよという警告
Internet ExplorerはIE特化アプリから一時的に日本を救ってくれたけど次回はもう助けてくれないよという警告
Hiroshi Kawada223K views
書籍向け汎用マークアップのあり方―Re:VIEWの開発を通して by Kenshi Muto
書籍向け汎用マークアップのあり方―Re:VIEWの開発を通して書籍向け汎用マークアップのあり方―Re:VIEWの開発を通して
書籍向け汎用マークアップのあり方―Re:VIEWの開発を通して
Kenshi Muto17.2K views
今だからこそ知りたい Docker Compose/Swarm 入門 by Masahito Zembutsu
今だからこそ知りたい Docker Compose/Swarm 入門今だからこそ知りたい Docker Compose/Swarm 入門
今だからこそ知りたい Docker Compose/Swarm 入門
Masahito Zembutsu23.2K views
Sphinx で手軽に作るドキュメント by Go Yamada
Sphinx で手軽に作るドキュメントSphinx で手軽に作るドキュメント
Sphinx で手軽に作るドキュメント
Go Yamada9.4K views
やりなおせる Git 入門 by Tomohiko Himura
やりなおせる Git 入門やりなおせる Git 入門
やりなおせる Git 入門
Tomohiko Himura85.1K views
Sphinxで社内勉強会(Git)の
資料を作ってみた by Taku SHIMIZU
Sphinxで社内勉強会(Git)の
資料を作ってみたSphinxで社内勉強会(Git)の
資料を作ってみた
Sphinxで社内勉強会(Git)の
資料を作ってみた
Taku SHIMIZU13.9K views
書籍制作でReVIEWを使う実践ワークフロー by Masahiro Hidaka
書籍制作でReVIEWを使う実践ワークフロー書籍制作でReVIEWを使う実践ワークフロー
書籍制作でReVIEWを使う実践ワークフロー
Masahiro Hidaka13.7K views

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

儲かるドキュメント by
儲かるドキュメント儲かるドキュメント
儲かるドキュメントYoshiki Shibukawa
2.3K views63 slides
[20101203] ドキュメントを作りたくなってしまう魔法のツールsphinx(山口発表用) by
[20101203] ドキュメントを作りたくなってしまう魔法のツールsphinx(山口発表用)[20101203] ドキュメントを作りたくなってしまう魔法のツールsphinx(山口発表用)
[20101203] ドキュメントを作りたくなってしまう魔法のツールsphinx(山口発表用)Yoshifumi Yamaguchi
802 views18 slides
Benchmarker - A Good Friend for Performance by
Benchmarker - A Good Friend for PerformanceBenchmarker - A Good Friend for Performance
Benchmarker - A Good Friend for Performancekwatch
2.9K views21 slides
Bitbucket&mercurial by
Bitbucket&mercurialBitbucket&mercurial
Bitbucket&mercurialYoshiki Shibukawa
2.4K views26 slides
Python arch wiki by
Python   arch wikiPython   arch wiki
Python arch wikifikrul islamy
975 views6 slides
Tokyotextmining#1 kaneyama genta by
Tokyotextmining#1 kaneyama gentaTokyotextmining#1 kaneyama genta
Tokyotextmining#1 kaneyama gentagenta kaneyama
1.9K views40 slides

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

[20101203] ドキュメントを作りたくなってしまう魔法のツールsphinx(山口発表用) by Yoshifumi Yamaguchi
[20101203] ドキュメントを作りたくなってしまう魔法のツールsphinx(山口発表用)[20101203] ドキュメントを作りたくなってしまう魔法のツールsphinx(山口発表用)
[20101203] ドキュメントを作りたくなってしまう魔法のツールsphinx(山口発表用)
Benchmarker - A Good Friend for Performance by kwatch
Benchmarker - A Good Friend for PerformanceBenchmarker - A Good Friend for Performance
Benchmarker - A Good Friend for Performance
kwatch2.9K views
Tokyotextmining#1 kaneyama genta by genta kaneyama
Tokyotextmining#1 kaneyama gentaTokyotextmining#1 kaneyama genta
Tokyotextmining#1 kaneyama genta
genta kaneyama1.9K views
7 steps for highly effective deep neural networks by Natalino Busa
7 steps for highly effective deep neural networks7 steps for highly effective deep neural networks
7 steps for highly effective deep neural networks
Natalino Busa501 views
Package Management via Spack on SJTU π Supercomputer by Jianwen Wei
Package Management via Spack on SJTU π SupercomputerPackage Management via Spack on SJTU π Supercomputer
Package Management via Spack on SJTU π Supercomputer
Jianwen Wei896 views
A Whirlwind Tour Of Python by Asia Smith
A Whirlwind Tour Of PythonA Whirlwind Tour Of Python
A Whirlwind Tour Of Python
Asia Smith5 views
How Not To Be Seen by Mark Pesce
How Not To Be SeenHow Not To Be Seen
How Not To Be Seen
Mark Pesce813 views
The Offensive Python - Practical Python for Penetration Testing by Satria Ady Pradana
The Offensive Python - Practical Python for Penetration TestingThe Offensive Python - Practical Python for Penetration Testing
The Offensive Python - Practical Python for Penetration Testing
Satria Ady Pradana438 views
The Offensive Python: Practical Python for Penetration Testing by Satria Ady Pradana
The Offensive Python: Practical Python for Penetration TestingThe Offensive Python: Practical Python for Penetration Testing
The Offensive Python: Practical Python for Penetration Testing
Satria Ady Pradana182 views
関西 Unconferance Sphinx かわいいよ Sphinx by Shinya Ohyanagi
関西 Unconferance Sphinx かわいいよ Sphinx関西 Unconferance Sphinx かわいいよ Sphinx
関西 Unconferance Sphinx かわいいよ Sphinx
Shinya Ohyanagi1.8K views
PyPy 1.2: snakes never crawled so fast by PyCon Italia
PyPy 1.2: snakes never crawled so fastPyPy 1.2: snakes never crawled so fast
PyPy 1.2: snakes never crawled so fast
PyCon Italia1.2K views
File formats for Next Generation Sequencing by Pierre Lindenbaum
File formats for Next Generation SequencingFile formats for Next Generation Sequencing
File formats for Next Generation Sequencing
Pierre Lindenbaum23.6K views

More from Takayuki Shimizukawa

IKEv2-VPN PyHackCon2023 by
IKEv2-VPN PyHackCon2023IKEv2-VPN PyHackCon2023
IKEv2-VPN PyHackCon2023Takayuki Shimizukawa
21 views23 slides
Django ORM道場:クエリの基本を押さえ,より良い形を身に付けよう by
Django ORM道場:クエリの基本を押さえ,より良い形を身に付けようDjango ORM道場:クエリの基本を押さえ,より良い形を身に付けよう
Django ORM道場:クエリの基本を押さえ,より良い形を身に付けようTakayuki Shimizukawa
199 views52 slides
OpenTelemetryでWebシステムの処理を追跡しよう - DjangoCongress JP 2022 by
OpenTelemetryでWebシステムの処理を追跡しよう - DjangoCongress JP 2022OpenTelemetryでWebシステムの処理を追跡しよう - DjangoCongress JP 2022
OpenTelemetryでWebシステムの処理を追跡しよう - DjangoCongress JP 2022Takayuki Shimizukawa
1.5K views46 slides
Webアプリを並行開発する際のマイグレーション戦略 by
Webアプリを並行開発する際のマイグレーション戦略Webアプリを並行開発する際のマイグレーション戦略
Webアプリを並行開発する際のマイグレーション戦略Takayuki Shimizukawa
4.8K views49 slides
『自走プログラマー』 が我々に必要だった理由 by
『自走プログラマー』 が我々に必要だった理由『自走プログラマー』 が我々に必要だった理由
『自走プログラマー』 が我々に必要だった理由Takayuki Shimizukawa
743 views22 slides
エキスパートPythonプログラミング改訂3版の読みどころ by
エキスパートPythonプログラミング改訂3版の読みどころエキスパートPythonプログラミング改訂3版の読みどころ
エキスパートPythonプログラミング改訂3版の読みどころTakayuki Shimizukawa
1.8K views23 slides

More from Takayuki Shimizukawa(20)

Django ORM道場:クエリの基本を押さえ,より良い形を身に付けよう by Takayuki Shimizukawa
Django ORM道場:クエリの基本を押さえ,より良い形を身に付けようDjango ORM道場:クエリの基本を押さえ,より良い形を身に付けよう
Django ORM道場:クエリの基本を押さえ,より良い形を身に付けよう
OpenTelemetryでWebシステムの処理を追跡しよう - DjangoCongress JP 2022 by Takayuki Shimizukawa
OpenTelemetryでWebシステムの処理を追跡しよう - DjangoCongress JP 2022OpenTelemetryでWebシステムの処理を追跡しよう - DjangoCongress JP 2022
OpenTelemetryでWebシステムの処理を追跡しよう - DjangoCongress JP 2022
Webアプリを並行開発する際のマイグレーション戦略 by Takayuki Shimizukawa
Webアプリを並行開発する際のマイグレーション戦略Webアプリを並行開発する際のマイグレーション戦略
Webアプリを並行開発する際のマイグレーション戦略
『自走プログラマー』 が我々に必要だった理由 by Takayuki Shimizukawa
『自走プログラマー』 が我々に必要だった理由『自走プログラマー』 が我々に必要だった理由
『自走プログラマー』 が我々に必要だった理由
エキスパートPythonプログラミング改訂3版の読みどころ by Takayuki Shimizukawa
エキスパートPythonプログラミング改訂3版の読みどころエキスパートPythonプログラミング改訂3版の読みどころ
エキスパートPythonプログラミング改訂3版の読みどころ
RLSを用いたマルチテナント実装 for Django by Takayuki Shimizukawa
RLSを用いたマルチテナント実装 for DjangoRLSを用いたマルチテナント実装 for Django
RLSを用いたマルチテナント実装 for Django
Takayuki Shimizukawa11.1K views
【修正版】Django + SQLAlchemy: シンプルWay by Takayuki Shimizukawa
【修正版】Django + SQLAlchemy: シンプルWay【修正版】Django + SQLAlchemy: シンプルWay
【修正版】Django + SQLAlchemy: シンプルWay
Takayuki Shimizukawa11.3K views
Sphinx customization for OGP support at SphinxCon JP 2018 by Takayuki Shimizukawa
Sphinx customization for OGP support at SphinxCon JP 2018Sphinx customization for OGP support at SphinxCon JP 2018
Sphinx customization for OGP support at SphinxCon JP 2018
Pythonはどうやってlen関数で長さを手にいれているの? by Takayuki Shimizukawa
Pythonはどうやってlen関数で長さを手にいれているの?Pythonはどうやってlen関数で長さを手にいれているの?
Pythonはどうやってlen関数で長さを手にいれているの?
Takayuki Shimizukawa38.1K views
仕事で使うちょっとしたコードをOSSとして開発メンテしていく - Django Redshift Backend の開発 - PyCon JP 2016 by Takayuki Shimizukawa
仕事で使うちょっとしたコードをOSSとして開発メンテしていく- Django Redshift Backend の開発 - PyCon JP 2016仕事で使うちょっとしたコードをOSSとして開発メンテしていく- Django Redshift Backend の開発 - PyCon JP 2016
仕事で使うちょっとしたコードをOSSとして開発メンテしていく - Django Redshift Backend の開発 - PyCon JP 2016
Easy contributable internationalization process with Sphinx @ PyCon APAC 2016 by Takayuki Shimizukawa
Easy contributable internationalization process with Sphinx @ PyCon APAC 2016Easy contributable internationalization process with Sphinx @ PyCon APAC 2016
Easy contributable internationalization process with Sphinx @ PyCon APAC 2016
素振りのススメ at Python入門者の集い by Takayuki Shimizukawa
素振りのススメ at Python入門者の集い素振りのススメ at Python入門者の集い
素振りのススメ at Python入門者の集い
JUS関西 Sphinxワークショップ@関西 Sphinx紹介 by Takayuki Shimizukawa
JUS関西 Sphinxワークショップ@関西 Sphinx紹介JUS関西 Sphinxワークショップ@関西 Sphinx紹介
JUS関西 Sphinxワークショップ@関西 Sphinx紹介
Sphinxで作る貢献しやすい ドキュメント翻訳の仕組み by Takayuki Shimizukawa
Sphinxで作る貢献しやすいドキュメント翻訳の仕組みSphinxで作る貢献しやすいドキュメント翻訳の仕組み
Sphinxで作る貢献しやすい ドキュメント翻訳の仕組み
Takayuki Shimizukawa28.1K views
Sphinx autodoc - automated api documentation - PyCon.KR 2015 by Takayuki Shimizukawa
Sphinx autodoc - automated api documentation - PyCon.KR 2015Sphinx autodoc - automated api documentation - PyCon.KR 2015
Sphinx autodoc - automated api documentation - PyCon.KR 2015
Easy contributable internationalization process with Sphinx @ pyconmy2015 by Takayuki Shimizukawa
Easy contributable internationalization process with Sphinx @ pyconmy2015Easy contributable internationalization process with Sphinx @ pyconmy2015
Easy contributable internationalization process with Sphinx @ pyconmy2015
Sphinx autodoc - automated api documentation - PyCon.MY 2015 by Takayuki Shimizukawa
Sphinx autodoc - automated api documentation - PyCon.MY 2015Sphinx autodoc - automated api documentation - PyCon.MY 2015
Sphinx autodoc - automated api documentation - PyCon.MY 2015

Recently uploaded

Initiating and Advancing Your Strategic GIS Governance Strategy by
Initiating and Advancing Your Strategic GIS Governance StrategyInitiating and Advancing Your Strategic GIS Governance Strategy
Initiating and Advancing Your Strategic GIS Governance StrategySafe Software
140 views68 slides
The Role of Patterns in the Era of Large Language Models by
The Role of Patterns in the Era of Large Language ModelsThe Role of Patterns in the Era of Large Language Models
The Role of Patterns in the Era of Large Language ModelsYunyao Li
80 views65 slides
Digital Personal Data Protection (DPDP) Practical Approach For CISOs by
Digital Personal Data Protection (DPDP) Practical Approach For CISOsDigital Personal Data Protection (DPDP) Practical Approach For CISOs
Digital Personal Data Protection (DPDP) Practical Approach For CISOsPriyanka Aash
153 views59 slides
VNF Integration and Support in CloudStack - Wei Zhou - ShapeBlue by
VNF Integration and Support in CloudStack - Wei Zhou - ShapeBlueVNF Integration and Support in CloudStack - Wei Zhou - ShapeBlue
VNF Integration and Support in CloudStack - Wei Zhou - ShapeBlueShapeBlue
163 views54 slides
The Power of Heat Decarbonisation Plans in the Built Environment by
The Power of Heat Decarbonisation Plans in the Built EnvironmentThe Power of Heat Decarbonisation Plans in the Built Environment
The Power of Heat Decarbonisation Plans in the Built EnvironmentIES VE
69 views20 slides
Backroll, News and Demo - Pierre Charton, Matthias Dhellin, Ousmane Diarra - ... by
Backroll, News and Demo - Pierre Charton, Matthias Dhellin, Ousmane Diarra - ...Backroll, News and Demo - Pierre Charton, Matthias Dhellin, Ousmane Diarra - ...
Backroll, News and Demo - Pierre Charton, Matthias Dhellin, Ousmane Diarra - ...ShapeBlue
146 views15 slides

Recently uploaded(20)

Initiating and Advancing Your Strategic GIS Governance Strategy by Safe Software
Initiating and Advancing Your Strategic GIS Governance StrategyInitiating and Advancing Your Strategic GIS Governance Strategy
Initiating and Advancing Your Strategic GIS Governance Strategy
Safe Software140 views
The Role of Patterns in the Era of Large Language Models by Yunyao Li
The Role of Patterns in the Era of Large Language ModelsThe Role of Patterns in the Era of Large Language Models
The Role of Patterns in the Era of Large Language Models
Yunyao Li80 views
Digital Personal Data Protection (DPDP) Practical Approach For CISOs by Priyanka Aash
Digital Personal Data Protection (DPDP) Practical Approach For CISOsDigital Personal Data Protection (DPDP) Practical Approach For CISOs
Digital Personal Data Protection (DPDP) Practical Approach For CISOs
Priyanka Aash153 views
VNF Integration and Support in CloudStack - Wei Zhou - ShapeBlue by ShapeBlue
VNF Integration and Support in CloudStack - Wei Zhou - ShapeBlueVNF Integration and Support in CloudStack - Wei Zhou - ShapeBlue
VNF Integration and Support in CloudStack - Wei Zhou - ShapeBlue
ShapeBlue163 views
The Power of Heat Decarbonisation Plans in the Built Environment by IES VE
The Power of Heat Decarbonisation Plans in the Built EnvironmentThe Power of Heat Decarbonisation Plans in the Built Environment
The Power of Heat Decarbonisation Plans in the Built Environment
IES VE69 views
Backroll, News and Demo - Pierre Charton, Matthias Dhellin, Ousmane Diarra - ... by ShapeBlue
Backroll, News and Demo - Pierre Charton, Matthias Dhellin, Ousmane Diarra - ...Backroll, News and Demo - Pierre Charton, Matthias Dhellin, Ousmane Diarra - ...
Backroll, News and Demo - Pierre Charton, Matthias Dhellin, Ousmane Diarra - ...
ShapeBlue146 views
Hypervisor Agnostic DRS in CloudStack - Brief overview & demo - Vishesh Jinda... by ShapeBlue
Hypervisor Agnostic DRS in CloudStack - Brief overview & demo - Vishesh Jinda...Hypervisor Agnostic DRS in CloudStack - Brief overview & demo - Vishesh Jinda...
Hypervisor Agnostic DRS in CloudStack - Brief overview & demo - Vishesh Jinda...
ShapeBlue120 views
"Surviving highload with Node.js", Andrii Shumada by Fwdays
"Surviving highload with Node.js", Andrii Shumada "Surviving highload with Node.js", Andrii Shumada
"Surviving highload with Node.js", Andrii Shumada
Fwdays53 views
CloudStack and GitOps at Enterprise Scale - Alex Dometrius, Rene Glover - AT&T by ShapeBlue
CloudStack and GitOps at Enterprise Scale - Alex Dometrius, Rene Glover - AT&TCloudStack and GitOps at Enterprise Scale - Alex Dometrius, Rene Glover - AT&T
CloudStack and GitOps at Enterprise Scale - Alex Dometrius, Rene Glover - AT&T
ShapeBlue112 views
2FA and OAuth2 in CloudStack - Andrija Panić - ShapeBlue by ShapeBlue
2FA and OAuth2 in CloudStack - Andrija Panić - ShapeBlue2FA and OAuth2 in CloudStack - Andrija Panić - ShapeBlue
2FA and OAuth2 in CloudStack - Andrija Panić - ShapeBlue
ShapeBlue103 views
Why and How CloudStack at weSystems - Stephan Bienek - weSystems by ShapeBlue
Why and How CloudStack at weSystems - Stephan Bienek - weSystemsWhy and How CloudStack at weSystems - Stephan Bienek - weSystems
Why and How CloudStack at weSystems - Stephan Bienek - weSystems
ShapeBlue197 views
GDG Cloud Southlake 28 Brad Taylor and Shawn Augenstein Old Problems in the N... by James Anderson
GDG Cloud Southlake 28 Brad Taylor and Shawn Augenstein Old Problems in the N...GDG Cloud Southlake 28 Brad Taylor and Shawn Augenstein Old Problems in the N...
GDG Cloud Southlake 28 Brad Taylor and Shawn Augenstein Old Problems in the N...
James Anderson156 views
CloudStack Managed User Data and Demo - Harikrishna Patnala - ShapeBlue by ShapeBlue
CloudStack Managed User Data and Demo - Harikrishna Patnala - ShapeBlueCloudStack Managed User Data and Demo - Harikrishna Patnala - ShapeBlue
CloudStack Managed User Data and Demo - Harikrishna Patnala - ShapeBlue
ShapeBlue94 views
iSAQB Software Architecture Gathering 2023: How Process Orchestration Increas... by Bernd Ruecker
iSAQB Software Architecture Gathering 2023: How Process Orchestration Increas...iSAQB Software Architecture Gathering 2023: How Process Orchestration Increas...
iSAQB Software Architecture Gathering 2023: How Process Orchestration Increas...
Bernd Ruecker50 views
KVM Security Groups Under the Hood - Wido den Hollander - Your.Online by ShapeBlue
KVM Security Groups Under the Hood - Wido den Hollander - Your.OnlineKVM Security Groups Under the Hood - Wido den Hollander - Your.Online
KVM Security Groups Under the Hood - Wido den Hollander - Your.Online
ShapeBlue181 views
Updates on the LINSTOR Driver for CloudStack - Rene Peinthor - LINBIT by ShapeBlue
Updates on the LINSTOR Driver for CloudStack - Rene Peinthor - LINBITUpdates on the LINSTOR Driver for CloudStack - Rene Peinthor - LINBIT
Updates on the LINSTOR Driver for CloudStack - Rene Peinthor - LINBIT
ShapeBlue166 views
Developments to CloudStack’s SDN ecosystem: Integration with VMWare NSX 4 - P... by ShapeBlue
Developments to CloudStack’s SDN ecosystem: Integration with VMWare NSX 4 - P...Developments to CloudStack’s SDN ecosystem: Integration with VMWare NSX 4 - P...
Developments to CloudStack’s SDN ecosystem: Integration with VMWare NSX 4 - P...
ShapeBlue154 views
Future of AR - Facebook Presentation by Rob McCarty
Future of AR - Facebook PresentationFuture of AR - Facebook Presentation
Future of AR - Facebook Presentation
Rob McCarty62 views

ドキュメントを作りたくなってしまう魔法のツール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
  • 6. 3    
  • 7.       100%     sphinx-­‐user.jp              http://sphinx-­‐users.jp/example.html      http://sphinx.pocoo.org/examples.html  
  • 9.     1.  Sphinx   2.  Sphinx   3.  reST   4.  Sphinx              
  • 10. 1/4  Sphinx   2         Python,  easy_install,  Sphinx 3         Ubuntu   $  sudo  apt-­‐get  install  python-­‐sphinx     Mac  OS  X   $  sudo  port  install  python-­‐sphinx    
  • 11. 2/4  Sphinx   “sphinx-­‐quickstart”   $  mkdir  Unix-­‐How-­‐to   $  cd  Unix-­‐How-­‐to     $  sphinx-­‐quickstart   Enter    .         conf.py             3                            
  • 12. 3/4  reST   reST  =  reStructuredText     http://sphinx-­‐users.jp/doc10/rest.html   ============         ============             =========             -­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐   -­‐  1     toctree   -­‐  2      #.   1      #.   2
  • 13. 4/4  Sphinx   Makefile $  make  html ============       ============       =========   1   2   -­‐  1        1.   1   -­‐  2        2.   2    #.   1      #.   2
  • 14.  1/2   HTML LaTeX PDF   ePub   $  make  latex   $  make  latexpdf     $  make  epub   HTML  
  • 15.    “Jinja2”     2 html      :  layout.html      :  page.html      basic    
  • 16. Sphinx   OSS     Python  2.6.2     OpenPNE  Web  API     groonga …      
  • 17. Sphinx   Sphinx     Python &    (Erlang,  Ruby,  C++,  JavaScript…)       )    C   c:function::  int  printf(const  char  *format,  …) ..  
  • 18. Sphinx               Sphinx    
  • 19. Sphinx   autodoc  –  docstring       intersphinx  –   Sphinx     pngmath  –   PNG     jsmath  –  JavaScript     graphviz  –  Graphviz     coverage  –       todo  –  Todo   Sphinx  
  • 20. Sphinx       sdedit     UML     blockdiag         docx     Sphinx Word  
  • 21. 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()  
  • 22. blockdiag  by  @tk0miya       sphinxcontrib-­‐blockdiag   Sphinx   ..  blockdiag::          diagram  webapp  {                  login  -­‐>  something  -­‐>  logout  -­‐>  login              }
  • 23. docx   Sphinx Word      by    
  • 24.   Sphinx                              
  • 26.         Word         OpenOffice  Writer Microsoft Office  
  • 27.         Excel     Calc   Microsoft Office  
  • 28.         PowerPoint     KeyNote     OpenOffice  Impress  
  • 29.         Wiki     HTML     TeX  
  • 30. 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
  • 31. Word  -­‐  pros                 etc…   http://www.flickr.com/photos/jetalone/861945664/   CC  BY  by  jetalone
  • 32. Word  -­‐  cons   1             http://www.flickr.com/photos/jetalone/861945664/   CC  BY  by  jetalone
  • 33. Excel  -­‐  pros   Excel           http://www.flickr.com/photos/ 21183810@N00/4366518191/  CC  BY-­‐NC-­‐SA  by  Jerome   Rothermund
  • 34. Excel  -­‐  cons       http://www.flickr.com/photos/ 21183810@N00/4366518191/  CC  BY-­‐NC-­‐SA  by  Jerome   Rothermund
  • 35. Wiki  -­‐  pros             http://www.flickr.com/photos/ 7506006@N07/1197395511/  CC  BY-­‐NC-­‐ND  by  milky.way
  • 36. Wiki  -­‐  cons       Wikipedia         http://www.flickr.com/photos/ 7506006@N07/1197395511/  CC  BY-­‐NC-­‐ND  by  milky.way
  • 37. Sphinx  -­‐  pros               OK http://www.flickr.com/photos/ 18261299@N00/4472408386/  CC  BY-­‐SA  by  sweet_redbird
  • 38. Sphinx  -­‐  cons           WYSIWIG http://www.flickr.com/photos/ 18261299@N00/4472408386/  CC  BY-­‐SA  by  sweet_redbird
  • 40.       toctree toctree toctree        
  • 41.       #,  *,  =,  -­‐,  ^,  ~,  “         H1,  H2,  H3..    
  • 42.   Sphinx     toctree                                                              
  • 43.       toctree 1     toctree toctree Sphinx
  • 46.   •    •  + (UNIX )   •  ( )   • 
  • 48.   ( )     ..  _ : :ref:` ` ..  module::   :mod:` ` ..  function::   :func:` ` ..  class::   :class:` ` ..  method::   :meth:` ` ..  attr::   :attr:` ` berrymq.talk ( )! "
  • 49.                      
  • 50.   •    • 
  • 51.  
  • 52. 40% 60%  
  • 53.                                        
  • 54. ω `)
  • 56.                           ..
  • 57. 1.    2.      3.    4.   
  • 59.  
  • 60. 7   1.    2.    3.    4.    5.  6.  7.    Python 10 10 :
  • 61.           APPENDIX  
  • 62.                  
  • 63. 3 JUS
  • 64. Step1  Sphinx C:>  sphinx-­‐quickstart
  • 65. Step2    
  • 66. Step3      
  • 67. Step4      
  • 68.    
  • 69.  
  • 71.  
  • 72.  
  • 73. XP 2010 http:// .jp/docs/xpfest2010/          
  • 75. Python 10 10 :
  • 76. 1.        2.        3.        4.     
  • 77. (´ ω `)