SlideShare a Scribd company logo
1 of 49
Download to read offline
sphinx
                        “
                    :
                                         ”

                        2011/11/18 t2y




2011   11   18
(             )
                 Python
                 Twitter: @t2y (      ) , @t2y_en (   )
                 G+: gplus.to/t2y (              )
                 Hatena:
                  forest book (                           )
                  forest nook (              )


2011   11   18
python
                           python
                 python



                            10 :


                              sphinx


                                       4



2011   11   18
sphinx
                 rest


                 sphinx
                 sphinx   python
                 sphinx



2011   11   18
sphinx                      (1)

                 python


                 Georg Brandl
                                          "Pocoo is
                 pocoo               1    pronounced /ˈpokʉː/"

                 2005      python
                 python3


2011   11   18
sphinx                     (2)

                       doxygen


                 sphinx:
                  docutils: REST
                  pygments:
                  jinja2: HTML



2011   11   18
sphinx                     (3)


                 latex                 latex
                 makefile
                  rest
                           (gettext)



2011   11   18
$ make help
                 Please use `make <target>' where <target> is one of
                  html     to make standalone HTML files
                  dirhtml to make HTML files called index.html in directories
                  singlehtml to make one big HTML file
                  text    to make text files
                  man     to make manual pages
                                                          django
                  pickle   to make pickle files           json
                  json    to make json files
                  htmlhelp to make HTML files and a HTML help project
                  qthelp    to make Qt help files and project
                  devhelp to make Devhelp files and project
                  epub     to make an epub file
                  latex    to make LaTeX files, you can set PAPER=a4 or PAPER=letter
                  latexpdf to make LaTeX files and run pdflatex
                  texinfo to make Texinfo files
                  info    to make Texinfo files and run them through makeinfo
                  gettext to make PO message catalogs
                  changes to make an overview over all changed/added/deprecated items
                  linkcheck to check all external links for integrity



2011   11   18
sphinx                 (4)


                  doc/xls
                 rest
                                     .. blockdiag::

                  blockdiag:           {
                                           A [label="    "];
                                           A -> B [label="Open"];
                                           A -> C;

                                           O -> P -> C;
                                       }




2011   11   18
sphinx                   (5)
                 sphinx
                  python
                    python
                    sqlalchemy


                    groonga
                    symfony2


2011   11   18
sphinx                     (6)


                 sphinx-users.jp
                 sphinx
                 sphinx
                    :              :




2011   11   18
sphinx
                 rest


                 sphinx
                 sphinx   python
                 sphinx



2011   11   18
rest

                 WIKI

                 STRUCTUREDTEXT
                 PYTHON



                   reStructuredText



2011   11   18
rest



                 :




2011   11   18
sphinx



                 : sphinx rest




2011   11   18
sphinx
                 rest


                 sphinx
                 sphinx   python
                 sphinx



2011   11   18
:
                 :
                 :




2011   11   18
10 :
                 2
                      sphinx




2011   11   18
(   )




2011   11   18
sphinx




2011   11   18
rest
                                 =>
                                           =>
                 html/epub/pdf        =>



2011   11   18
sphinx
                 rest


                 sphinx
                 sphinx   python
                 sphinx



2011   11   18
sphinx


                 pypi sphinxcontrib
                  30
                 pypi sphinxjp
                  8



2011   11   18
sphinxcontrib.spelling

                 sphinxcontrib.spelling
                  doug hellmann
                  pyenchant
                  sphinx




2011   11   18
sphinxjp.themes.s6
                 sphinxjp.themes.s6


                  rest
                  s6       js
                  s6             (    css)
                  “..s6:: xxx”



2011   11   18
blockdiag
                 blockdiag




                  diag
                    seqdiag
                    actdiag
                    nwdiag
                    rackdiag


2011   11   18
sphinxjp.shibukawa


                 sphinxjp.shibukawa




2011   11   18
sphinx
                 rest


                 sphinx
                 sphinx   python
                 sphinx



2011   11   18
docstring

                 sphinx
                  python


                           docstring




2011   11   18
sphinx            python




                 python




2011   11   18
python
                 setup.py


                  python               : distutils
                  distutils                : distribute
                    :
                          web: distutils, setuptools,
                    distribute, pip, virtualenv, buildout


2011   11   18
api

                 e.g) flask
                                          javadoc
                 $ cd flask_repository
                 $ python setup.py build_sphinx
                  build/sphinx/html




2011   11   18
sphinx
                 rest


                 sphinx
                 sphinx   python
                 sphinx



2011   11   18
pypy




2011   11   18
python
                 django
                 pyramid




2011   11   18
python
                  django
                  pyramid
                 web



2011   11   18
python    (v2.7.2)

                                      1424    page
                  C/API                192 page
                                       122 page

                 django    (v1.3)     1129 page
                 pyramid   (v1.2)     670 page


2011   11   18
python
                 learning python (   :         python)
                      : Mark Lutz
                    1 (1999/4)           384 page
                    2 (2003/12)          624 page
                    3 (2007/10)          752 page
                    4 (2009/9)           1216 page



2011   11   18
python
                 programming python (    :          python)
                      : Mark Lutz
                    1 (1996/10)          902 page
                    2 (2001/3)          1296 page
                    3 (2006/8)          1600 page
                    4 (2010/12)         1632 page



2011   11   18
Mark Lutz


                  “python        ”
                 python
                          1000



2011   11   18
sphinx
                 rest


                 sphinx
                 sphinx   python
                 sphinx



2011   11   18
sphinx
                            python
                  pymotw & python insider
                  ikazuchi




2011   11   18
sphinx
                 ikazuchi




2011   11   18
sphinx

                            Python
                 PyMOTW

                 Python Insider




2011   11   18
ikazuchi

                 PyPI   ikazuchi
                 ikazuchi
                  CUI
                    google translate api
                    microsoft translate API




2011   11   18
ikazuchi
                        ikazuchi


                 PyPI
                 python
                 europython        lt
                 (sphinxcontrib-ikazuchi   )



2011   11   18
sphinx
                                         sphinx




                          (gettext)

                 quickstart

                              (doc/xls      )


2011   11   18
rest
                 sphinx




2011   11   18
happy documenting
                        with sphinx


2011   11   18

More Related Content

Similar to Sphinx 社内勉強会

Easy contributable internationalization process with Sphinx @ PyCon APAC 2016
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 2016Takayuki Shimizukawa
 
Easy contributable internationalization process with Sphinx @ pyconmy2015
Easy contributable internationalization process with Sphinx @ pyconmy2015Easy contributable internationalization process with Sphinx @ pyconmy2015
Easy contributable internationalization process with Sphinx @ pyconmy2015Takayuki Shimizukawa
 
Easy contributable internationalization process with Sphinx @ pyconsg2015
Easy contributable internationalization process with Sphinx @ pyconsg2015Easy contributable internationalization process with Sphinx @ pyconsg2015
Easy contributable internationalization process with Sphinx @ pyconsg2015Takayuki Shimizukawa
 
Easy contributable internationalization process with Sphinx (PyCon APAC 2015 ...
Easy contributable internationalization process with Sphinx (PyCon APAC 2015 ...Easy contributable internationalization process with Sphinx (PyCon APAC 2015 ...
Easy contributable internationalization process with Sphinx (PyCon APAC 2015 ...Takayuki Shimizukawa
 
関西 Unconferance Sphinx かわいいよ Sphinx
関西 Unconferance Sphinx かわいいよ Sphinx関西 Unconferance Sphinx かわいいよ Sphinx
関西 Unconferance Sphinx かわいいよ SphinxShinya Ohyanagi
 
Crifanlib python
Crifanlib pythonCrifanlib python
Crifanlib pythoncri fan
 
Crifanlib python
Crifanlib pythonCrifanlib python
Crifanlib pythoncri fan
 
LingPy : A Python Library for Historical Linguistics
LingPy : A Python Library for Historical LinguisticsLingPy : A Python Library for Historical Linguistics
LingPy : A Python Library for Historical LinguisticsDr. Amit Kumar Jha
 
PyPy's approach to construct domain-specific language runtime
PyPy's approach to construct domain-specific language runtimePyPy's approach to construct domain-specific language runtime
PyPy's approach to construct domain-specific language runtimeNational Cheng Kung University
 
Plone - A History of Python Web
Plone - A History of Python WebPlone - A History of Python Web
Plone - A History of Python WebAlexander Loechel
 
Jenkins Shared Libraries Workshop
Jenkins Shared Libraries WorkshopJenkins Shared Libraries Workshop
Jenkins Shared Libraries WorkshopJulien Pivotto
 
Python Master Thesis Projects in UK.
Python Master Thesis Projects in UK.Python Master Thesis Projects in UK.
Python Master Thesis Projects in UK.Phdtopiccom
 

Similar to Sphinx 社内勉強会 (12)

Easy contributable internationalization process with Sphinx @ PyCon APAC 2016
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
 
Easy contributable internationalization process with Sphinx @ pyconmy2015
Easy contributable internationalization process with Sphinx @ pyconmy2015Easy contributable internationalization process with Sphinx @ pyconmy2015
Easy contributable internationalization process with Sphinx @ pyconmy2015
 
Easy contributable internationalization process with Sphinx @ pyconsg2015
Easy contributable internationalization process with Sphinx @ pyconsg2015Easy contributable internationalization process with Sphinx @ pyconsg2015
Easy contributable internationalization process with Sphinx @ pyconsg2015
 
Easy contributable internationalization process with Sphinx (PyCon APAC 2015 ...
Easy contributable internationalization process with Sphinx (PyCon APAC 2015 ...Easy contributable internationalization process with Sphinx (PyCon APAC 2015 ...
Easy contributable internationalization process with Sphinx (PyCon APAC 2015 ...
 
関西 Unconferance Sphinx かわいいよ Sphinx
関西 Unconferance Sphinx かわいいよ Sphinx関西 Unconferance Sphinx かわいいよ Sphinx
関西 Unconferance Sphinx かわいいよ Sphinx
 
Crifanlib python
Crifanlib pythonCrifanlib python
Crifanlib python
 
Crifanlib python
Crifanlib pythonCrifanlib python
Crifanlib python
 
LingPy : A Python Library for Historical Linguistics
LingPy : A Python Library for Historical LinguisticsLingPy : A Python Library for Historical Linguistics
LingPy : A Python Library for Historical Linguistics
 
PyPy's approach to construct domain-specific language runtime
PyPy's approach to construct domain-specific language runtimePyPy's approach to construct domain-specific language runtime
PyPy's approach to construct domain-specific language runtime
 
Plone - A History of Python Web
Plone - A History of Python WebPlone - A History of Python Web
Plone - A History of Python Web
 
Jenkins Shared Libraries Workshop
Jenkins Shared Libraries WorkshopJenkins Shared Libraries Workshop
Jenkins Shared Libraries Workshop
 
Python Master Thesis Projects in UK.
Python Master Thesis Projects in UK.Python Master Thesis Projects in UK.
Python Master Thesis Projects in UK.
 

More from Tetsuya Morimoto

ビジネスパーソン x プログラミング
ビジネスパーソン x プログラミングビジネスパーソン x プログラミング
ビジネスパーソン x プログラミングTetsuya Morimoto
 
チケット駆動開発のススメ
チケット駆動開発のススメチケット駆動開発のススメ
チケット駆動開発のススメTetsuya Morimoto
 
Pythonと型チェッカー
Pythonと型チェッカーPythonと型チェッカー
Pythonと型チェッカーTetsuya Morimoto
 
PyLadies Tokyo 二周年記念パーティ LT
PyLadies Tokyo 二周年記念パーティ LTPyLadies Tokyo 二周年記念パーティ LT
PyLadies Tokyo 二周年記念パーティ LTTetsuya Morimoto
 
PyCon JP 2016 ビギナーセッション
PyCon JP 2016 ビギナーセッションPyCon JP 2016 ビギナーセッション
PyCon JP 2016 ビギナーセッションTetsuya Morimoto
 
ストリーミングのげんざい
ストリーミングのげんざいストリーミングのげんざい
ストリーミングのげんざいTetsuya Morimoto
 
Python3 プログラミング勉強会
Python3 プログラミング勉強会Python3 プログラミング勉強会
Python3 プログラミング勉強会Tetsuya Morimoto
 
Ikazuchi introduction for Europython 2011 LT
Ikazuchi introduction for Europython 2011 LTIkazuchi introduction for Europython 2011 LT
Ikazuchi introduction for Europython 2011 LTTetsuya Morimoto
 
Python界隈の翻訳プロジェクト
Python界隈の翻訳プロジェクトPython界隈の翻訳プロジェクト
Python界隈の翻訳プロジェクトTetsuya Morimoto
 
エキ Py 読書会02 2章後半
エキ Py 読書会02 2章後半エキ Py 読書会02 2章後半
エキ Py 読書会02 2章後半Tetsuya Morimoto
 
エキ Py 読書会02 2章前半
エキ Py 読書会02 2章前半エキ Py 読書会02 2章前半
エキ Py 読書会02 2章前半Tetsuya Morimoto
 
エキ Py 読書会02 2010/9/7
エキ Py 読書会02 2010/9/7エキ Py 読書会02 2010/9/7
エキ Py 読書会02 2010/9/7Tetsuya Morimoto
 

More from Tetsuya Morimoto (16)

ビジネスパーソン x プログラミング
ビジネスパーソン x プログラミングビジネスパーソン x プログラミング
ビジネスパーソン x プログラミング
 
チケット駆動開発のススメ
チケット駆動開発のススメチケット駆動開発のススメ
チケット駆動開発のススメ
 
Pythonと型チェッカー
Pythonと型チェッカーPythonと型チェッカー
Pythonと型チェッカー
 
PyLadies Tokyo 二周年記念パーティ LT
PyLadies Tokyo 二周年記念パーティ LTPyLadies Tokyo 二周年記念パーティ LT
PyLadies Tokyo 二周年記念パーティ LT
 
PyCon JP 2016 ビギナーセッション
PyCon JP 2016 ビギナーセッションPyCon JP 2016 ビギナーセッション
PyCon JP 2016 ビギナーセッション
 
Hyper Introduction
Hyper IntroductionHyper Introduction
Hyper Introduction
 
ストリーミングのげんざい
ストリーミングのげんざいストリーミングのげんざい
ストリーミングのげんざい
 
Python3 プログラミング勉強会
Python3 プログラミング勉強会Python3 プログラミング勉強会
Python3 プログラミング勉強会
 
PyCon 2012 紀行
PyCon 2012 紀行PyCon 2012 紀行
PyCon 2012 紀行
 
Ikazuchi introduction for Europython 2011 LT
Ikazuchi introduction for Europython 2011 LTIkazuchi introduction for Europython 2011 LT
Ikazuchi introduction for Europython 2011 LT
 
Python界隈の翻訳プロジェクト
Python界隈の翻訳プロジェクトPython界隈の翻訳プロジェクト
Python界隈の翻訳プロジェクト
 
エキ Py 読書会02 2章後半
エキ Py 読書会02 2章後半エキ Py 読書会02 2章後半
エキ Py 読書会02 2章後半
 
エキ Py 読書会02 2章前半
エキ Py 読書会02 2章前半エキ Py 読書会02 2章前半
エキ Py 読書会02 2章前半
 
エキ Py 読書会02 2010/9/7
エキ Py 読書会02 2010/9/7エキ Py 読書会02 2010/9/7
エキ Py 読書会02 2010/9/7
 
Ex py intro-20100630
Ex py intro-20100630Ex py intro-20100630
Ex py intro-20100630
 
曖昧 RPM 講座
曖昧 RPM 講座曖昧 RPM 講座
曖昧 RPM 講座
 

Recently uploaded

The State of Passkeys with FIDO Alliance.pptx
The State of Passkeys with FIDO Alliance.pptxThe State of Passkeys with FIDO Alliance.pptx
The State of Passkeys with FIDO Alliance.pptxLoriGlavin3
 
DevoxxFR 2024 Reproducible Builds with Apache Maven
DevoxxFR 2024 Reproducible Builds with Apache MavenDevoxxFR 2024 Reproducible Builds with Apache Maven
DevoxxFR 2024 Reproducible Builds with Apache MavenHervé Boutemy
 
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024BookNet Canada
 
Unraveling Multimodality with Large Language Models.pdf
Unraveling Multimodality with Large Language Models.pdfUnraveling Multimodality with Large Language Models.pdf
Unraveling Multimodality with Large Language Models.pdfAlex Barbosa Coqueiro
 
Advanced Computer Architecture – An Introduction
Advanced Computer Architecture – An IntroductionAdvanced Computer Architecture – An Introduction
Advanced Computer Architecture – An IntroductionDilum Bandara
 
Ensuring Technical Readiness For Copilot in Microsoft 365
Ensuring Technical Readiness For Copilot in Microsoft 365Ensuring Technical Readiness For Copilot in Microsoft 365
Ensuring Technical Readiness For Copilot in Microsoft 3652toLead Limited
 
SALESFORCE EDUCATION CLOUD | FEXLE SERVICES
SALESFORCE EDUCATION CLOUD | FEXLE SERVICESSALESFORCE EDUCATION CLOUD | FEXLE SERVICES
SALESFORCE EDUCATION CLOUD | FEXLE SERVICESmohitsingh558521
 
Developer Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQLDeveloper Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQLScyllaDB
 
Digital Identity is Under Attack: FIDO Paris Seminar.pptx
Digital Identity is Under Attack: FIDO Paris Seminar.pptxDigital Identity is Under Attack: FIDO Paris Seminar.pptx
Digital Identity is Under Attack: FIDO Paris Seminar.pptxLoriGlavin3
 
The Role of FIDO in a Cyber Secure Netherlands: FIDO Paris Seminar.pptx
The Role of FIDO in a Cyber Secure Netherlands: FIDO Paris Seminar.pptxThe Role of FIDO in a Cyber Secure Netherlands: FIDO Paris Seminar.pptx
The Role of FIDO in a Cyber Secure Netherlands: FIDO Paris Seminar.pptxLoriGlavin3
 
Unleash Your Potential - Namagunga Girls Coding Club
Unleash Your Potential - Namagunga Girls Coding ClubUnleash Your Potential - Namagunga Girls Coding Club
Unleash Your Potential - Namagunga Girls Coding ClubKalema Edgar
 
What is DBT - The Ultimate Data Build Tool.pdf
What is DBT - The Ultimate Data Build Tool.pdfWhat is DBT - The Ultimate Data Build Tool.pdf
What is DBT - The Ultimate Data Build Tool.pdfMounikaPolabathina
 
SAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptxSAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptxNavinnSomaal
 
TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024Lonnie McRorey
 
Merck Moving Beyond Passwords: FIDO Paris Seminar.pptx
Merck Moving Beyond Passwords: FIDO Paris Seminar.pptxMerck Moving Beyond Passwords: FIDO Paris Seminar.pptx
Merck Moving Beyond Passwords: FIDO Paris Seminar.pptxLoriGlavin3
 
Hyperautomation and AI/ML: A Strategy for Digital Transformation Success.pdf
Hyperautomation and AI/ML: A Strategy for Digital Transformation Success.pdfHyperautomation and AI/ML: A Strategy for Digital Transformation Success.pdf
Hyperautomation and AI/ML: A Strategy for Digital Transformation Success.pdfPrecisely
 
"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii SoldatenkoFwdays
 
Are Multi-Cloud and Serverless Good or Bad?
Are Multi-Cloud and Serverless Good or Bad?Are Multi-Cloud and Serverless Good or Bad?
Are Multi-Cloud and Serverless Good or Bad?Mattias Andersson
 
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024BookNet Canada
 
SIP trunking in Janus @ Kamailio World 2024
SIP trunking in Janus @ Kamailio World 2024SIP trunking in Janus @ Kamailio World 2024
SIP trunking in Janus @ Kamailio World 2024Lorenzo Miniero
 

Recently uploaded (20)

The State of Passkeys with FIDO Alliance.pptx
The State of Passkeys with FIDO Alliance.pptxThe State of Passkeys with FIDO Alliance.pptx
The State of Passkeys with FIDO Alliance.pptx
 
DevoxxFR 2024 Reproducible Builds with Apache Maven
DevoxxFR 2024 Reproducible Builds with Apache MavenDevoxxFR 2024 Reproducible Builds with Apache Maven
DevoxxFR 2024 Reproducible Builds with Apache Maven
 
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
 
Unraveling Multimodality with Large Language Models.pdf
Unraveling Multimodality with Large Language Models.pdfUnraveling Multimodality with Large Language Models.pdf
Unraveling Multimodality with Large Language Models.pdf
 
Advanced Computer Architecture – An Introduction
Advanced Computer Architecture – An IntroductionAdvanced Computer Architecture – An Introduction
Advanced Computer Architecture – An Introduction
 
Ensuring Technical Readiness For Copilot in Microsoft 365
Ensuring Technical Readiness For Copilot in Microsoft 365Ensuring Technical Readiness For Copilot in Microsoft 365
Ensuring Technical Readiness For Copilot in Microsoft 365
 
SALESFORCE EDUCATION CLOUD | FEXLE SERVICES
SALESFORCE EDUCATION CLOUD | FEXLE SERVICESSALESFORCE EDUCATION CLOUD | FEXLE SERVICES
SALESFORCE EDUCATION CLOUD | FEXLE SERVICES
 
Developer Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQLDeveloper Data Modeling Mistakes: From Postgres to NoSQL
Developer Data Modeling Mistakes: From Postgres to NoSQL
 
Digital Identity is Under Attack: FIDO Paris Seminar.pptx
Digital Identity is Under Attack: FIDO Paris Seminar.pptxDigital Identity is Under Attack: FIDO Paris Seminar.pptx
Digital Identity is Under Attack: FIDO Paris Seminar.pptx
 
The Role of FIDO in a Cyber Secure Netherlands: FIDO Paris Seminar.pptx
The Role of FIDO in a Cyber Secure Netherlands: FIDO Paris Seminar.pptxThe Role of FIDO in a Cyber Secure Netherlands: FIDO Paris Seminar.pptx
The Role of FIDO in a Cyber Secure Netherlands: FIDO Paris Seminar.pptx
 
Unleash Your Potential - Namagunga Girls Coding Club
Unleash Your Potential - Namagunga Girls Coding ClubUnleash Your Potential - Namagunga Girls Coding Club
Unleash Your Potential - Namagunga Girls Coding Club
 
What is DBT - The Ultimate Data Build Tool.pdf
What is DBT - The Ultimate Data Build Tool.pdfWhat is DBT - The Ultimate Data Build Tool.pdf
What is DBT - The Ultimate Data Build Tool.pdf
 
SAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptxSAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptx
 
TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024
 
Merck Moving Beyond Passwords: FIDO Paris Seminar.pptx
Merck Moving Beyond Passwords: FIDO Paris Seminar.pptxMerck Moving Beyond Passwords: FIDO Paris Seminar.pptx
Merck Moving Beyond Passwords: FIDO Paris Seminar.pptx
 
Hyperautomation and AI/ML: A Strategy for Digital Transformation Success.pdf
Hyperautomation and AI/ML: A Strategy for Digital Transformation Success.pdfHyperautomation and AI/ML: A Strategy for Digital Transformation Success.pdf
Hyperautomation and AI/ML: A Strategy for Digital Transformation Success.pdf
 
"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko
 
Are Multi-Cloud and Serverless Good or Bad?
Are Multi-Cloud and Serverless Good or Bad?Are Multi-Cloud and Serverless Good or Bad?
Are Multi-Cloud and Serverless Good or Bad?
 
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
 
SIP trunking in Janus @ Kamailio World 2024
SIP trunking in Janus @ Kamailio World 2024SIP trunking in Janus @ Kamailio World 2024
SIP trunking in Janus @ Kamailio World 2024
 

Sphinx 社内勉強会

  • 1. sphinx “ : ” 2011/11/18 t2y 2011 11 18
  • 2. ( ) Python Twitter: @t2y ( ) , @t2y_en ( ) G+: gplus.to/t2y ( ) Hatena: forest book ( ) forest nook ( ) 2011 11 18
  • 3. python python python 10 : sphinx 4 2011 11 18
  • 4. sphinx rest sphinx sphinx python sphinx 2011 11 18
  • 5. sphinx (1) python Georg Brandl "Pocoo is pocoo 1 pronounced /ˈpokʉː/" 2005 python python3 2011 11 18
  • 6. sphinx (2) doxygen sphinx: docutils: REST pygments: jinja2: HTML 2011 11 18
  • 7. sphinx (3) latex latex makefile rest (gettext) 2011 11 18
  • 8. $ make help Please use `make <target>' where <target> is one of html to make standalone HTML files dirhtml to make HTML files called index.html in directories singlehtml to make one big HTML file text to make text files man to make manual pages django pickle to make pickle files json json to make json files htmlhelp to make HTML files and a HTML help project qthelp to make Qt help files and project devhelp to make Devhelp files and project epub to make an epub file latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter latexpdf to make LaTeX files and run pdflatex texinfo to make Texinfo files info to make Texinfo files and run them through makeinfo gettext to make PO message catalogs changes to make an overview over all changed/added/deprecated items linkcheck to check all external links for integrity 2011 11 18
  • 9. sphinx (4) doc/xls rest .. blockdiag:: blockdiag: { A [label=" "]; A -> B [label="Open"]; A -> C; O -> P -> C; } 2011 11 18
  • 10. sphinx (5) sphinx python python sqlalchemy groonga symfony2 2011 11 18
  • 11. sphinx (6) sphinx-users.jp sphinx sphinx : : 2011 11 18
  • 12. sphinx rest sphinx sphinx python sphinx 2011 11 18
  • 13. rest WIKI STRUCTUREDTEXT PYTHON reStructuredText 2011 11 18
  • 14. rest : 2011 11 18
  • 15. sphinx : sphinx rest 2011 11 18
  • 16. sphinx rest sphinx sphinx python sphinx 2011 11 18
  • 17. : : : 2011 11 18
  • 18. 10 : 2 sphinx 2011 11 18
  • 19. ( ) 2011 11 18
  • 20. sphinx 2011 11 18
  • 21. rest => => html/epub/pdf => 2011 11 18
  • 22. sphinx rest sphinx sphinx python sphinx 2011 11 18
  • 23. sphinx pypi sphinxcontrib 30 pypi sphinxjp 8 2011 11 18
  • 24. sphinxcontrib.spelling sphinxcontrib.spelling doug hellmann pyenchant sphinx 2011 11 18
  • 25. sphinxjp.themes.s6 sphinxjp.themes.s6 rest s6 js s6 ( css) “..s6:: xxx” 2011 11 18
  • 26. blockdiag blockdiag diag seqdiag actdiag nwdiag rackdiag 2011 11 18
  • 27. sphinxjp.shibukawa sphinxjp.shibukawa 2011 11 18
  • 28. sphinx rest sphinx sphinx python sphinx 2011 11 18
  • 29. docstring sphinx python docstring 2011 11 18
  • 30. sphinx python python 2011 11 18
  • 31. python setup.py python : distutils distutils : distribute : web: distutils, setuptools, distribute, pip, virtualenv, buildout 2011 11 18
  • 32. api e.g) flask javadoc $ cd flask_repository $ python setup.py build_sphinx build/sphinx/html 2011 11 18
  • 33. sphinx rest sphinx sphinx python sphinx 2011 11 18
  • 34. pypy 2011 11 18
  • 35. python django pyramid 2011 11 18
  • 36. python django pyramid web 2011 11 18
  • 37. python (v2.7.2) 1424 page C/API 192 page 122 page django (v1.3) 1129 page pyramid (v1.2) 670 page 2011 11 18
  • 38. python learning python ( : python) : Mark Lutz 1 (1999/4) 384 page 2 (2003/12) 624 page 3 (2007/10) 752 page 4 (2009/9) 1216 page 2011 11 18
  • 39. python programming python ( : python) : Mark Lutz 1 (1996/10) 902 page 2 (2001/3) 1296 page 3 (2006/8) 1600 page 4 (2010/12) 1632 page 2011 11 18
  • 40. Mark Lutz “python ” python 1000 2011 11 18
  • 41. sphinx rest sphinx sphinx python sphinx 2011 11 18
  • 42. sphinx python pymotw & python insider ikazuchi 2011 11 18
  • 43. sphinx ikazuchi 2011 11 18
  • 44. sphinx Python PyMOTW Python Insider 2011 11 18
  • 45. ikazuchi PyPI ikazuchi ikazuchi CUI google translate api microsoft translate API 2011 11 18
  • 46. ikazuchi ikazuchi PyPI python europython lt (sphinxcontrib-ikazuchi ) 2011 11 18
  • 47. sphinx sphinx (gettext) quickstart (doc/xls ) 2011 11 18
  • 48. rest sphinx 2011 11 18
  • 49. happy documenting with sphinx 2011 11 18