Docutils Hacker's Guide
Docutils Hacker's Guide Author: Lea Wiemann Contact: [email protected].net Revision: 9906 Date: 2024-08-15 Copyright: This document has been placed in the public domain. Prerequisites: You have used reStructuredText and played around with the Docutils front-end tools before. Some (basic) Python knowledge is certainly helpful (though not necessary, strictly speaking). Abstract This
reSTãŠã‚ˆã³Sphinxã§æ–‡ç« を書ãéš›ã®tips - ãã“ã¯ã‹ã¨ãªã書ãよ。
Sphinxを使ã£ã¦è«–æ–‡ã£ã½ã„æ–‡ç« ã‚’æ›¸ãã¨ãã®tipsã‚’ã¾ã¨ã‚ã¦ãŠãã¾ã™ã€‚ 追記: ã“ã®å†…容㯠Sphinx逆引ã辞典ã«ã‚ˆã‚Šè©³ç´°ã«ã—ã¦è¼‰ã£ã¦ã„ã¾ã™ã€‚ 用語を書ãéš›ã¯replaceを使ㆠ.. |hoge| replace:: ã»ã’らã“ã†å®šç¾©ã—ã¦ãŠãã¨æ¬¡ã‹ã‚‰ã¯ |hoge| ã¨ã™ã‚‹ã ã‘ã§ã€ã»ã’らã¨è‡ªå‹•çš„ã«å±•é–‹ã—ã¦ãã‚Œã¾ã™ã€‚ã¤ã¾ã‚Šã€ã‚ã¨ã‹ã‚‰ã“ã®ç”¨èªžåを変ãˆãŸã„ãªã€ã¨æ€ã£ãŸã¨ãã«ã¯ã“ã®å®šç¾©ã®ã¨ã“ã‚ã ã‘を変ãˆã‚Œã°å‹æ‰‹ã«å…¨éƒ¨å…¥ã‚Œæ›¿ãˆã¦ãれるã€ã¨ã„ã†ã‚ã‘ã§ã™ã€‚ ãŸã ã—ã€è¤‡æ•°ã®rstファイルã«åˆ†ã‘ã¦ã„ã‚‹å ´åˆã«ã¯ä½¿ãˆãªã„ã®ã§ã€åˆ¥ã®ãƒ•ã‚¡ã‚¤ãƒ«(例ãˆã°definition.txt)ã« replace を書ã„ã¦ãŠã〠.. include:: definition.txtã¨å„rstファイルã®å…ˆé ã«æ›¸ã„ã¦ãŠãã¾ã™ã€‚ã“ã®æ™‚ã€.rstã§ã¯ãªã.txtãªã©ä»–ã®æ‹¡å¼µåã®ãƒ•ã‚¡ã‚¤ãƒ«ã«æ›¸ã„ã¦ã„ã‚‹ã“ã¨ã«æ³¨æ„ã—ã¦ãã ã•ã„。ãã†ã—ãªã„
reStructuredText入門
è¦å‘Š ã“ã®è¨˜äº‹ã¯å¤ã„為 easy_install ã®ä½¿ç”¨ç‰ã€ç¾åœ¨ã§ã¯éžæŽ¨å¥¨ã®èª¬æ˜ŽãŒã‚ã‚Šã¾ã™ã€‚インストール周りã«ã¤ã„ã¦ã¯ Windowsã¸ã®ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã®æ‰‹é †ã‚’å‚ç…§ã—ã¦ãã ã•ã„。 reStructuredTextã¯reSTã¨ã‚‚呼ã°ã‚Œã¾ã™ã€‚ (http://docutils.sourceforge.net/rst.html (英語) ã‚’å‚ç…§ã—ã¦ãã ã•ã„。) reSTã¯ã€ãƒ—レーンテã‚ストを使ã£ãŸãƒžãƒ¼ã‚¯ã‚¢ãƒƒãƒ—言語ã§ã€ãƒ‘ッケージã®ãƒ‰ã‚ュメントを作æˆã™ã‚‹éš›ã«ã€Pythonã®ã‚³ãƒŸãƒ¥ãƒ‹ãƒ†ã‚£å†…ã§åºƒã使用ã•ã‚Œã¦ã„ã¾ã™ã€‚reSTã®å„ªã‚Œã¦ã„る点ã¯ã€ã‚½ãƒ¼ã‚¹ã®ãƒ†ã‚ストã®çŠ¶æ…‹ã§ã‚‚ãã®ã¾ã¾èªã‚€ã“ã¨ãŒã§ãã‚‹ã¨ã„ã†ç‚¹ã§ã™ã€‚LaTeXã®ã‚ˆã†ã«ã€ãƒžãƒ¼ã‚¯ã‚¢ãƒƒãƒ—ã®æ–‡æ³•ã®ã›ã„ã§èªã¿ã«ãããªã‚‹ã¨ã„ã†ã“ã¨ã¯ã‚ã‚Šã¾ã›ã‚“。 以下ã®ãƒ†ã‚ストã¯ã€reSTå½¢å¼ã®ãƒ‰ã‚ュメントã®ã‚µãƒ³ãƒ—ルã§ã™ã€‚ ======== タイトル ======== セクション
reStructuredText
Markup Syntax and Parser Component of Docutils Date: 2025-09-13 reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents. reStructuredText is designed for extensibility for specific application domains. T
1
ランã‚ング
ランã‚ング
ãŠçŸ¥ã‚‰ã›
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
{{#tags}}- {{label}}
{{/tags}}