TERASOLUNA Server Framework for Java (5.x) Development Guideline¶
TERASOLUNA Server Framework for Java (5.x) Development Guideline — TERASOLUNA Server Framework for Java (5.x) Development Guideline 5.6.1.RELEASE documentation
TERASOLUNA Server Framework for Java (5.x) Development Guideline¶
Sphinxã¸ã®ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ« — Oktavia
ドã‚ュメントツール Sphinx ã«Oktaviaを組ã¿è¾¼ã‚€ã®ã¯ç°¡å˜ã«ã§ãã¾ã™ã€‚ Sphinxドã‚ュメントã«Oktaviaを組ã¿è¾¼ã‚€ã«ã¯ã€ï¼’ã¤ã®ã‚¹ãƒ†ãƒƒãƒ—ãŒã‚ã‚Šã¾ã™ã€‚ インデックスファイルã®æº–å‚™ Sphinxテンプレートã®å¤‰æ›´ インデックスファイルã®æº–å‚™ Oktaviaã®ãƒ„ールã¨ãƒ©ã‚¤ãƒ–ラリをgithubã‹ã‚‰ãƒ€ã‚¦ãƒ³ãƒãƒ¼ãƒ‰ã—ã¾ã™ã€‚ https://github.com/shibukawa/oktavia ã“ã®ãƒ‰ã‚ュメントã§ã¯ oktavia フォルダãŒSphinxã®ãƒ‰ã‚ュメントフォルダ内ã«ç½®ã‹ã‚ŒãŸã‚‚ã®ã¨ã—ã¦é€²ã‚ã¾ã™ã€‚ ãƒãƒ¥ãƒ¼ãƒˆãƒªã‚¢ãƒ«ã‚’èªã¾ã‚Œã¦ã„ãªã„æ–¹ã¯ã€ã¾ãšã¯node.jsをインストールã—ã¾ã™ã€‚インデックスジェãƒãƒ¬ãƒ¼ã‚¿ã¯node.jsã®ä¸Šã§å®Ÿè¡Œã•ã‚Œã¾ã™ã€‚ node.jsã®ã‚¦ã‚§ãƒ–サイト ã«ã¯ã€ã•ã¾ã–ã¾ãªãƒ—ラットフォームã¸ã®ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã®ä»•æ–¹ãŒæ›¸ã‹ã‚Œã¦ã„ã¾ã™ã€‚ ã¾ãšæœ€åˆã«ã€ç”Ÿæˆã—ãŸHTMLã®ãƒ‰ã‚ュメ
Python: docstring を書ã„ã¦ã¿ã‚ˆã† - CUBE SUGAR CONTAINER
Python ã® docstring ã¨ã„ã†ã®ã¯ã€ãƒ¢ã‚¸ãƒ¥ãƒ¼ãƒ«ã‚„クラスã€é–¢æ•°ãªã©ã«ã¤ã‘る説明文ã®ã“ã¨ã€‚ å˜ç´”ãªã‚³ãƒ¡ãƒ³ãƒˆã¨ã®é•ã„ã¯ã€ã‚ˆã‚Šä»•æ§˜ã«è¿‘ã„内容を記述ã—ã¦ãŠãã“ã¨ã§ API ã®ãƒ‰ã‚ュメントã¨ã—ã¦åˆ©ç”¨ã§ãã‚‹ä»–ã€åˆ¥ã®ãƒ‰ã‚ュメントã‹ã‚‰å†…容をèªã¿è¾¼ã‚“ã§ä½¿ã£ãŸã‚Šã™ã‚‹ã“ã¨ãŒã§ãる。 今回㯠docstring ã®æ›¸ã‹ã‚ŒãŸã‚µãƒ³ãƒ—ルコードを元ã«ã€REPL ã‹ã‚‰ãã®å†…容をå‚ç…§ã—ãŸã‚Šã€ãƒ‰ã‚ュメンテーションツール Sphinx ã§ãã®å†…容をèªã¿è¾¼ã‚€ã¨ã„ã†ã®ã‚’試ã—ã¦ã¿ã‚‹ã€‚ docstring ã®æ›¸ã‹ã‚ŒãŸã‚½ãƒ¼ã‚¹ã‚³ãƒ¼ãƒ‰ã‚’用æ„ã™ã‚‹ 以下㌠docstring ã®æ›¸ã‹ã‚ŒãŸ Python ã®ã‚½ãƒ¼ã‚¹ã‚³ãƒ¼ãƒ‰ã€‚ 内容ã«ã¤ã„ã¦ã¯ FizzBuzz å•é¡Œã‚’é¡Œæã«ã—ã¦ã„る。 モジュールや関数ã®å…ˆé 㧠“â€â€œ ã‚„ ‘’‘ を使ã£ã¦ã‚³ãƒ¡ãƒ³ãƒˆã‚’書ã„ã¦ãŠãã¨ã€ãã‚ŒãŒè‡ªå‹•çš„ã« docstring ã¨ã—ã¦æ‰±ã‚れるã“ã¨ã«ãªã‚‹ã€‚ #!/usr/bi
Sphinx: æ—¢å˜ã®ãƒ†ãƒ¼ãƒžã‚’カスタマイズã™ã‚‹ - CUBE SUGAR CONTAINER
Sphinx ã¯ãƒ‰ã‚ュメントã®ã‚³ãƒ³ãƒ†ãƒ³ãƒ„ã¨ãƒ‡ã‚¶ã‚¤ãƒ³ãŒåˆ†é›¢ã•ã‚Œã¦ã„る。 デザインを変ãˆãŸã„ã¨ãã¯ãƒ†ãƒ¼ãƒžã‚’変更ã™ã‚Œã°è‰¯ã„。 ãŸã ã€æ—¢å˜ã®ãƒ†ãƒ¼ãƒžãã®ã¾ã¾ã§ã¯æº€è¶³ã§ãã‚‹è¦‹æ „ãˆã«ãªã‚‰ãªã„ã¨ãã‚‚ã‚る。 ãã‚“ãªã¨ãã¯æ—¢å˜ã®ãƒ†ãƒ¼ãƒžã‚’カスタマイズã™ã‚‹å¿…è¦ãŒå‡ºã¦ãる。 今回ã¯ãã®ã‚„ã‚Šæ–¹ã«ã¤ã„ã¦æ›¸ã。 環境ã«ã¯ Mac OS X を使ã£ã¦ã„る。 $ sw_vers ProductName: Mac OS X ProductVersion: 10.11.2 BuildVersion: 15C50 下準備 ã¾ãšã¯ä¸‹æº–å‚™ã¨ã—㦠Sphinx をインストールã™ã‚‹ã€‚ $ pip install sphinx 次㫠sphinx-quickstart コマンドを使ã£ã¦ãƒ‰ã‚ュメントを用æ„ã™ã‚‹ã€‚ デフォルトã®å…¥åŠ›å€¤ã‹ã‚‰å¤‰æ›´ã—ã¦ã„ã‚‹ã¨ã“ã‚ã ã‘示ã™ã€‚ $ sphinx-quickstart > Separate source an
Sphinxã®ãƒ†ãƒ¼ãƒžã‚’継承ã—ã¦ä½“è£ã‚’カスタマイズã—よã†
æ–Žè—¤ã§ã™ã€‚ã“ã‚“ã«ã¡ã¯ã€‚ 今日ã¯ã€Sphinxã§HTMLã®ãƒ‰ã‚ュメントを生æˆã™ã‚‹éš›ã€ãƒ‰ã‚ュメント全体ã«å¯¾ã—ã¦ä½“è£ã®å¤‰æ›´ã‚’è¡Œãˆã‚‹ã‚ˆã†ã€ãƒ†ãƒ¼ãƒžã‚’継承ã™ã‚‹æ–¹æ³•ã‚’ãŠè©±ã—ã—ã¾ã™ã€‚本記事ã§ã¯ã€ã€Œç¶™æ‰¿ã™ã‚‹ç†ç”±ã€ã€Œçµ„ã¿æ–¹ã€ãã—ã¦ã€Œæ³¨æ„点ã€ã®3点ã«ã¤ã„ã¦ã¾ã¨ã‚ã¾ã—ãŸã€‚ ※検証ã—ãŸã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ã°ã€Sphinxã¯1.1.3sphinxjp-latexã€Pythonã¯2.6.6 (CentOS 6.4標準rpm)ã§ã™ã€‚ 継承ã™ã‚‹ç†ç”± Sphinxã¨ã¯ã€Pythonã§å‹•ä½œã—ã€reStructuredText(以下ã€reST)ã§è¨˜è¿°ã™ã‚‹ãƒ‰ã‚ュメント生æˆã‚¨ãƒ³ã‚¸ãƒ³ã§ã™ã€‚出力ã¯ã€HTMLã°ã‹ã‚Šã§ãªãã€LaTeX(PDF)ã‚„manãªã©å¤šæ§˜ãªå½¢å¼ã‚’サãƒãƒ¼ãƒˆã—ã¦ã„ã¾ã™ã€‚ã¾ãŸã€HTML出力ã®éš›ã€ãƒ†ãƒ¼ãƒžã‚’利用ã—ã¦å®¹æ˜“ã«ä½“è£ã‚’変更ã™ã‚‹äº‹ãŒã§ãã¾ã™ã€‚ ã•ã¦ã€æ—¢å˜ã®Sphinxã®ãƒ†ãƒ¼ãƒžã‚’変更ã—ãŸããªã‚‹æ™‚ã¨ã¯ã€ã©ã®ã‚ˆã†ãªå ´åˆã§ã—ょ
1
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
{{#tags}}- {{label}}
{{/tags}}