æ¸æ¥è¨@shibu.jp æ¸å·ãããã®æ¥è¨ã§ããã½ããã¦ã§ã¢éçºã¨ããã©ã¤ãããã¯ãä¸å¿ã«è¨äºãæ¸ãã¦ããã¾ãã ãã®åã®ããã°ã®ã¨ã³ããªã¼ã«ãæ¸ãã¾ããããSphinxã¨ããã¹ããããããã¼ã«ãããã¾ããããã¥ã¡ã³ããã©ãã©ãæ¸ããããªã£ã¡ããã¹ãããªãã¼ã«ã§ããã§ãããæ®å¿µãªããã使ç¨ããããã«ã¯ã¤ã³ã¹ãã¼ã«ããå¿ è¦ãããã¾ããPythonã£ã¦ä½ï¼ã¨ãã人ã«ã¯å°ã æ·å± ãé«ãããã解説ã®è¨äºãæ¸ãã¦ã¿ã¾ããã [STEP 1] Pythonããã¤ã³ã¹ãã¼ã«ããå ´å Windowsã§ã¯Pythonããã¤ã³ã¹ãã¼ã«ããå¿ è¦ãããã¾ããä¸çºã§ã¤ã³ã¹ãã¼ã«ã§ããç°å¢ãæã£ã¦ããäººã¯æå¾ã®æ¹ã®ã¤ã³ã¹ãã¼ã«æ³ã«é£ãã§ãã ãããã¾ããMac OS Xã¿ããã«ãæåããPythonããå ¥ã£ã¦ãã人ã¯[STEP 1]ã¯é£ã°ãã¦ãã ããã Windwsã®å ´å http://python.orgãéãã¾ããP
å°ãåã«ä½ã£ã¦æ¾ç½®ãã¦ãã使ã£ã¦ã¿ãããã°ã©ãããWindowså°ç¨ã§ãã tokibito / rstedit / Downloads â Bitbucket è¿½è¨ VistaãWindows7ã§ã¯IEã³ã³ãã¼ãã³ãé¢é£ã®åé¡ã§åããªãããã§ãããã£ãããªåé¡ãªã®ã§ã解決çè¦ã¤ããã¾ã§ã¯æ¾ç½®ã§ãããã¿ã¾ããã
ã¯ããã« ããã«ã¡ã¯ãéã¢ãã¨ã³ã¸ãã¢ã§ããé·ããExcelã§ä»æ§æ¸ãæ¸ãã®ããã¼ã ãããã§ãããSphinxã§ããã¥ã¡ã³ããæ¸ãã¨è³ããè³æ¼¿åãæµãã«ãªã£ã¦ãã¾ãã»ã©æ¥½ãããªã£ã¦ãã¾ãã¨ãããã£ã±ãã®åï¼ä¿ºã®ä¸ã§ï¼ãªã®ã§ãEmacsã§reSTãæ¸ãéã®ä¾¿å©æ©è½ãã¾ã¨ãã¦ã¿ã¾ããã åç § 404 Not Found æåå³åã§ããèªåãé¢ãã£ã¦ããSphinxã®æ¥æ¬ã¦ã¼ã¶ä¼ã®ãµã¤ãã§ããããããSphinxã£ã¦ãªã«ãï¼Sphinxèªä½ãã©ããã£ã¦å°å ¥ãããããã®ãï¼ã£ã¦æ¹ã¯ãåç §ãã ããããã¡ããæ¢ã«ãåç¥ã®æ¹ã«ãææ°æ å ±å«ãæçãªæ å ±ãæºè¼ã§ãã Emacs Support for reStructuredText rst.elã®æ¬å®¶ãè±èªã§ããrst-modeã«ã¤ãã¦ä¸çªè©³ãã説æãããå ´æã ã¨æãã¾ãã rst.elã®è²è¨å® - DiaryException è²è¨å®ã«ã¤ãã¦è©³ãã説æ
Sphinx ã®ãããã§ reST ãã¾ãè¦ç´ããã¦ããï¼ ã¨ãããã¨ã§ Emacs ç¨ reStructuredText ã¢ã¼ãã®ã³ãã³ããã¼ããã ã»ã¯ã·ã§ã³ãã³ã¬ã¼ã·ã§ã³ ã»ã¯ã·ã§ã³ã®ã¿ã¤ãã«è£ 飾 C-c C-a rst-adjust C-c C-= rst-adjust C-= st-adjust (Mac OSX ããåããªãã) ããã¥ã¡ã³ãå ã®ã»ã¯ã·ã§ã³é層ã表示 C-c C-h rst-display-decorations-hierarchy ããã¥ã¡ã³ãå ã®è£ 飾ãåä¸å C-c C-s rst-straighten-decorations ã»ã¯ã·ã§ã³ã®ç§»åã¨é¸æ ã«ã¼ã½ã«ã®ãããµãã»ã¯ã·ã§ã³ã鏿 C-c C-m rst-mark-section ã»ã¯ã·ã§ã³éãé²ã/æ»ã C-c C-n rst-forward-section C-c C-p rst-backward-
ãã¦ã³ãã¼ã ãã®ããã¥ã¡ã³ãã¯ãã¼ã¸ã§ã³1.0 (hg)ã®ããã®ãã®ã§ããã¾ã ãªãªã¼ã¹ããã¦ãã¾ããã Mercurialãªãã¸ããªã®ã³ã¼ããå©ç¨ããããPython Package Indexã«ãããªãªã¼ã¹ãã¼ã¸ã§ã³ãæ¢ãã¦ãã ããã çå? æè¦? Googleã°ã«ã¼ãã¸ã®åå : ãããã¯ãFreeNodeã®#python-docsãã£ã³ãã«ã¸ã©ãã ä½ãæ°ã¥ãããã¨ãããã°ãissue trackerã使ç¨ãã¦éç¥ãããã¨ãã§ãã¾ãã Sphinxã¯ç¥çã§ç¾ããããã¥ã¡ã³ããç°¡åã«ä½ããããã«ãããã¼ã«ã§ããGeorg Brandlã«ãã£ã¦éçºãããBSDã©ã¤ã»ã³ã¹ã®ãã¨ã§å ¬éããã¦ãã¾ãã ãã®ãã¼ã«ã¯ãã¨ãã¨ãæ°ããPythonã®ããã¥ã¡ã³ãã®å¤æã®ããã«ä½ããã¾ãããããã¦ãä»ã¾ã§ã«æ°ã ã®Pythonããä»ã®è¨èªã§éçºããã¦ããããã¸ã§ã¯ãã«å¯¾ãã¦ããã°ãããããã¥ã¡ã³ãã¼ã·
Docutils: Documentation Utilities Written in Python, for General- and Special-Purpose Use Docutils is an open-source text processing system for processing plaintext documentation into useful formats, such as HTML, LaTeX, man-pages, OpenDocument, or XML. It includes reStructuredText, the easy to read, easy to use, what-you-see-is-what-you-get plaintext markup language. Overview To get up & running
æ¬ãã¼ã¯ã¢ããè¨æ³ã®å®å ¨ãªè©³ç´°ã¯ reStructuredText ã®ãã¼ã¸ã«ç¤ºããã¦ãã¾ãããã®ããã¹ãã¯ãè¦æ¸ã¨ãã¦ã®æ§æ ¼ã®ææ¸ã§ãã "(詳細)" ã¨ãããªã³ã¯ã辿ã㨠reStructuredText 仿§æ¸ãåç §ã§ãã¾ãã ãã ããç¸å¯¾ãªã³ã¯ã¨ãªã£ã¦ãã¾ãã®ã§ããªã³ã¯åãã®å ´åã¯ã åçã® "Quick reStructuredText" ããåç §ãã¦ãã ããã ç®æ¬¡ ã¤ã³ã©ã¤ã³ ãã¼ã¯ã¢ãã ããã¯ã¹ã©ãã·ã¥ã«ããã¨ã¹ã±ã¼ã ç« ç«ã¦ã®æ§é æ®µè½ è¨å·ã¤ããªã¹ã çªå·ã¤ããªã¹ã å®ç¾©ãªã¹ã ãã£ã¼ã«ããªã¹ã ãªãã·ã§ã³ãªã¹ã æ´å½¢æ¸ã¿ããã㯠ã©ã¤ã³ããã㯠å¼ç¨ Doctestããã㯠表 åºåãç· æç¤ºçãã¼ã¯ã¢ãã èæ³¨ åºå ¸ ãªã³ã¯ã¿ã¼ã²ãã å¤é¨ã¿ã¼ã²ãã å é¨ã¿ã¼ã²ãã 鿥ã¿ã¼ã²ãã æé»ã¿ã¼ã²ãã ãã£ã¬ã¯ãã£ã ä»£å ¥åç §ã¨ãã®å®ç¾© ã³ã¡ã³ã å©ããå¾ããå ´åã¯
ã©ã³ãã³ã°
ã©ã³ãã³ã°
é害
ãªãªã¼ã¹ãé害æ å ±ãªã©ã®ãµã¼ãã¹ã®ãç¥ãã
ææ°ã®äººæ°ã¨ã³ããªã¼ã®é ä¿¡
å¦çãå®è¡ä¸ã§ã
j次ã®ããã¯ãã¼ã¯
kåã®ããã¯ãã¼ã¯
lãã¨ã§èªã
eã³ã¡ã³ãä¸è¦§ãéã
oãã¼ã¸ãéã
{{#tags}}- {{label}}
{{/tags}}