Full featured documentation deployment platform
Documentation simplified Build, host, and share documentation, all with a single platform. Sign up now Automatic deploy previews Preview your documentation on every pull request. Never guess what you're shipping again. Ideal developer experience Write documentation with Git and your favorite text editor. Developers and writers both love docs as code. Work privately or publicly Share content with j
javasphinx User’s Guide — javasphinx 0.9.8 documentation
Configuration¶ To enable javasphinx for your existing Sphinx configuration add 'javasphinx' to the list of extensions in your conf.py file. javasphinx can be configured to cross link to external sources of documentation using the javadoc_url_map option, javadoc_url_map = { 'com.netflix.curator' : ('http://netflix.github.com/curator/doc', 'javadoc'), 'org.springframework' : ('http://static.springso
Sphinx ã§è‡ªå‹•çš„ã«APIリファレンスを作æˆã—ãŸã„ - Study08.net 対シンãƒã‚·æ®²æ»…用人型機動兵器
今日ã¯ã“ã®ãƒã‚¿ã§ã™ã€‚タイトルã®é€šã‚Šãªã‚“ã§ã™ãŒã€Pythonã§ãã‚‚ãã‚‚APIリファレンス的ãªãƒ‰ã‚ュメントをã©ã†ã‚„ã£ã¦ä½œã£ãŸã‚‰è‰¯ã„ã®ã‹çŸ¥ã‚Šã¾ã›ã‚“ã§ã—ãŸã€‚ ä»–ã®è¨€èªžã§ã‚ã‚Œã°ä¸‹è¨˜ã®ã‚ˆã†ãªãƒ„ールをéŽåŽ»ã«ä½¿ã£ãŸäº‹ãŒã‚ã‚Šã¾ã—ãŸã€‚ Java ãªã‚‰ Javadoc Perl ãªã‚‰ pod2html PHP ãªã‚‰ PHPDocumentor (今ãªã‚‰ã‚‚ã£ã¨è³¢ã„ツールã‚ã‚Šãã†ã ã‘ã©ã€‚。。) Pythonãªã‚‰? ã§ã¯Pythonã§ã‚ã‚Œã°ã©ã®ã‚ˆã†ãªé¸æŠžè‚¢ãŒã‚ã‚‹ã§ã—ょã†ã€‚調ã¹ãŸé™ã‚Šã§ã¯ã¾ãšä¸‹è¨˜ã®ã‚ˆã†ãªé¸æŠžè‚¢ãŒã‚ã‚Šã¾ã—ãŸã€‚ pydoc -w ã§HTMLç”Ÿæˆ (pydocã§ç°¡å˜ãªPythonファイルã®ãƒ‰ã‚ュメントを作æˆã™ã‚‹) Epydocを利用ã™ã‚‹ (Epydoc - åã£ãŸè¨€èªžä¿¡è€…ã®åž‚ã‚Œæµã—) javadocやらphpdocmentorやらã®ã‚ˆã†ã«ã€ã¾ã‚‹ã£ã¨ã‚½ãƒ¼ã‚¹ã‹ã‚‰HTMLを生æˆã™ã‚‹ã ã‘ã§ã‚ã‚Œã°ã€ã“ã‚Œã§å分ã‹ã‚‚ã—ã‚Œã¾
Sphinxã®ãƒ‰ã‚ュメントサンプル：æ¥å‹™åˆ©ç”¨ä¾‹
Sphinxã®ãƒ‰ã‚ュメントサンプル：æ¥å‹™åˆ©ç”¨ä¾‹Â¶ 日本UNIXユーザ会 2010å¹´12月勉強会 (2010/12/3) ã®ç™ºè¡¨ã§ä½¿ç”¨ã—ãŸãƒ‰ã‚ュメントを作りãŸããªã£ã¦ã—ã¾ã†é”法ã®ãƒ„ール Sphinx ã®ãƒ‡ãƒ¢ã§ä½¿ç”¨ã—ãŸãƒ‰ã‚ュメントã®ã²ãªå½¢ã§ã™ã€‚プレゼンテーションã®å…¨æ–‡ã¯ãƒ‰ã‚ュメントを作りãŸããªã£ã¦ã—ã¾ã†é”法ã®ãƒ„ール Sphinx ã«ã‚ã‚Šã¾ã™ã€‚ デモã§ä½¿ç”¨ã—ãŸSphinxã®ãƒ‰ã‚ュメントサンプルを以下ã®ãƒªãƒ³ã‚¯ã‹ã‚‰ãƒ€ã‚¦ãƒ³ãƒãƒ¼ãƒ‰å‡ºæ¥ã¾ã™ã€‚ Step2:ドã‚ュメントã®ä¾‹(Sphinxデータ) 2portfolio.zip Step2:ドã‚ュメントã®ä¾‹(HTML) Step1 Sphinxã®åˆæœŸãƒ‰ã‚ュメントã‹ã‚‰å§‹ã‚る¶ åˆæœŸãƒ‰ã‚ュメントã‹ã‚‰å§‹ã‚ã‚‹ã¨è¨€ã£ã¦ã‚‚〠sphinx-quickstart コマンドã§ä½œæˆã—ãŸã ã‘ã®çŠ¶æ…‹ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’共有ã—ã¦ã‚‚ã€ãã‚Œã§ã¯ãƒ‰ã‚ュメントを書ã„ã¦ãã‚Œãªã„ã§ã—ょã†ã€‚ã“ã‚Œã¯ã€Œã©ã†æ›¸
watchdogモジュールã®watchmedoコマンドãŒä¾¿åˆ© - åã£ãŸè¨€èªžä¿¡è€…ã®åž‚ã‚Œæµã—
誰ã‹ã‚‰æ•™ãˆã¦ã‚‚らã£ãŸã®ã‹å¿˜ã‚ŒãŸã‘ã©ã€ãƒ•ã‚¡ã‚¤ãƒ«ã®å¤‰æ›´ã‚’監視ã—ã¦ä½•ã‹å‡¦ç†ã‚’è¡Œã£ãŸã‚Šã§ãã‚‹watchdogã¨ã„ã†Pythonモジュールを試ã—ã¦ã¿ãŸã‚‰è‰¯ã„æ„Ÿã˜ã ã£ãŸã€‚ http://pypi.python.org/pypi/watchdog インストール PyPIã«ç™»éŒ²ã•ã‚Œã¦ã„ã‚‹ã®ã§easy_installã§ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã§ãる。 > easy_install watchdog watchmedoコマンドã®ä½¿ã„æ–¹ watchdogをインストールã™ã‚‹ã¨watchmedoã¨ã„ã†ã‚³ãƒžãƒ³ãƒ‰ãŒä½¿ãˆã‚‹ã€‚ watchmedoコマンドã¯ã€ãƒ•ã‚¡ã‚¤ãƒ«ã®å¤‰æ›´ãŒã‚ã£ãŸéš›ã«ã‚³ãƒžãƒ³ãƒ‰ã‚’実行ã—ãŸã‚Šã™ã‚‹ã“ã¨ãŒã§ãる。試ã—ãŸç’°å¢ƒã¯WindowsXP。 例ãˆã°ã‚«ãƒ¬ãƒ³ãƒˆãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªä»¥ä¸‹ã®æ‹¡å¼µåãŒrstã®ãƒ•ã‚¡ã‚¤ãƒ«ã®å¤‰æ›´ãŒã‚ã£ãŸå ´åˆã«ã€Sphinxã®make htmlを実行ã™ã‚‹ãªã‚‰ã“ã‚“ãªæ„Ÿã˜ã€‚ > watchmedo shell-comma
Paver: ソフトウェアプãƒã‚¸ã‚§ã‚¯ãƒˆã®ãŸã‚ã®ç°¡æ˜“スクリプティング — Paver v1.0.1 documentation
Paver: ソフトウェアプãƒã‚¸ã‚§ã‚¯ãƒˆã®ãŸã‚ã®ç°¡æ˜“スクリプティング¶ Paver 㯠Make ã‚„ Rake ã«ã‚ˆã似㟠Python ベースã®ã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆã®ã‚¹ã‚¯ãƒªãƒ—ティングツールã§ã™ã€‚例ãˆã° C 言語ã®ãƒ—ãƒã‚°ãƒ©ãƒ ã®ã‚ˆã†ã«å¿…è¦ãªä¾å˜é–¢ä¿‚を追跡ã—ã¦æ‰±ã†ã‚ˆã†ã«ã¯è¨è¨ˆã•ã‚Œã¦ã„ã¾ã›ã‚“。Python 構文ã¨è±Šå¯Œãªãƒ©ã‚¤ãƒ–ラリコードã®åˆ©ä¾¿æ€§ã«ã‚ˆã‚Šã€é›‘多ãªå…¨ã¦ã®ç¹°ã‚Šè¿”ã—タスク(ドã‚ュメントを生æˆã™ã‚‹ã€é–¢é€£ãƒ•ã‚¡ã‚¤ãƒ«ã‚’移動ã™ã‚‹ã€ãƒ€ã‚¦ãƒ³ãƒãƒ¼ãƒ‰ã™ã‚‹)ã«å¯¾ã—㦠補助ã™ã‚‹ã‚ˆã†ã« è¨è¨ˆã•ã‚Œã¦ã„ã¾ã™ 。 ã‚‚ã—ã‚ãªãŸãŒ Python ã§ã‚¢ãƒ—リケーションを開発ã—ã¦ã„ã‚‹ãªã‚‰ã€ãªãŠã•ã‚‰ä½¿ç”¨ã—ã¦ã¿ã¾ã—ょã†ã€‚大åŠã® Python ã®ãƒ‘ブリックプãƒã‚¸ã‚§ã‚¯ãƒˆã¯å†é…布å‘ã‘ã®ã‚½ãƒ¼ã‚¹ tarball を作æˆã™ã‚‹ãŸã‚ã« distutils ã‹ setuptools を使用ã—ã¾ã™(プライベートプãƒã‚¸ã‚§ã‚¯ãƒˆã‚‚ã“ã®åˆ©ç‚¹ã‚’å¾—ã‚‹ã“ã¨ãŒã§ãã‚‹ï¼
Sphinx-Users.jp :: ドã‚ュメンテーションツール スフィンクス Sphinx-users.jp
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)ã¯ã€ç¾Žã—ã„ドã‚ュメントを簡å˜ã«ç”Ÿæˆã™ã‚‹ã“ã¨ãŒã§ãるドã‚ュメンテーションツール〠Sphinx （スフィンクス）ã®æ™®åŠã‚’主眼ã¨ã—ãŸã‚³ãƒŸãƒ¥ãƒ‹ãƒ†ã‚£ã§ã™ã€‚Sphinxã¯Pythonã®å…¬å¼ãƒ‰ã‚ュメントã ã‘ã§ãªãã€ã“ã®Sphinx-Users.jpã®ã‚µã‚¤ãƒˆã‚‚å«ã‚多ãã®ãƒžãƒ‹ãƒ¥ã‚¢ãƒ«ã‚„サイトã§ä½¿ç”¨ã•ã‚Œã¦ãŠã‚Šã€è©³ç´°ã‚’ Sphinxã®æ´å²ã§ç´¹ä»‹ã—ã¦ã„ã¾ã™ã€‚ Sphinx-Users.jp ã¯æ—¥æœ¬ã® Sphinx コミュニティã§ã™ã€‚ Sphinx-Users.jp ã§ã¯ã€æ—¥æœ¬ã§æ•£ã‚‰ã°ã£ã¦ã„ã‚‹Sphinxé–¢é€£æƒ…å ±ã‚’é›†ã‚ã¦ã€Webサイトã€ã‚¤ãƒ™ãƒ³ãƒˆã‚’通ã˜ã¦Sphinxæƒ…å ±ã‚’ç™ºä¿¡ã—ã¾ã™ã€‚ slack ã®ã‚³ãƒŸãƒ¥ãƒ‹ã‚±ãƒ¼ã‚·ãƒ§ãƒ³ã‚„勉強会ã®é–‹å‚¬ãªã©ã‚’通ã˜ã¦ã€ãƒ‰ã‚ュメントをパワーアップã—ãŸã„人ã€ãƒ‰ã‚ュメントや翻訳ã§è‹¦åŠ´ã—ã¦ã„る人ã€Sphinxã®
ドã‚ュメントを作りãŸããªã£ã¦ã—ã¾ã†é”法ã®ãƒ„ールSphinx
http://sphinx-users.jp/event/20101203_jus_benkyoukai.html 日本UNIXユーザ会 2010å¹´12月勉強会 (2010/12/3) 日本UNIXユーザ会ã®2010å¹´12月ã®å‹‰å¼·ä¼šã«ã¦ã€ä»¥ä¸‹ã®å†…容ã§ç™ºè¡¨ã•ã›ã¦ã„ãŸã ãã¾ã—ãŸã€‚ 「ドã‚ュメントを作りãŸããªã£ã¦ã—ã¾ã†é”法ã®ãƒ„ール Sphinxã€Read less
2012.05版 Python開発ã®ãŠæ°—ã«å…¥ã‚Šæ§‹æˆï¼ˆãƒãƒãƒªã‚‚ã‚るよ） - YAMAGUCHI::weblog
ã¯ã˜ã‚ã« ã“ã‚“ã«ã¡ã¯ã€Pythonç•Œã®æƒ…å¼±ã§ã™ã€‚最近ã¯è‰²ã€…ã¨Pythonã®é–‹ç™ºç’°å¢ƒã‚‚変化ã—ã¦ãã¦ã„ã¦ã€ã‚ˆã†ã‚„ãPython2.xã¨Python3.xã‚’è¡Œãæ¥ã—ãªãŒã‚‰é–‹ç™ºã™ã‚‹ä½“制ãŒæ•´ã£ã¦ããŸã¨ã„ã†å°è±¡ã‚’å—ã‘ã¦ã„ã¾ã™ã€‚ã“ã“ã—ã°ã‚‰ãã¯è‰²ã€…ã¨è©¦ã—ã¦ã„ãŸã®ã§ã™ãŒã€ã‚ˆã†ã‚„ã鉄æ¿ã£ã½ã„方法ã«ãŸã©ã‚Šç€ã„ãŸã®ã§ãƒ¡ãƒ¢ã—ã¦ãŠãã¾ã™ã€‚ ãªãŠã€å¾ŒåŠã¯Pythonã«é™ã‚‰ãªã„内容ãªã®ã§ã€ä»–ã®LLを使ã£ã¦ã„ã¦ã‚‚使ãˆãã†ã‹ãªã¨æ€ã£ã¦ã„ã¾ã™ã€‚ã“ã®ç’°å¢ƒã‚’è¨å®šã™ã‚‹ã¨ä½•ãŒã§ãã‚‹ã®ã‹ã¨ã„ã†ã¨ã€ä»¥ä¸‹ã®ã“ã¨ã™ã¹ã¦ãŒã€ç„¡æ–™ã§ã€è‡ªé¯–ã‚’ç«‹ã¦ã‚‹ã“ã¨ãªãè¡Œãˆã¾ã™ã€‚ 開発環境ã®æ•´ç†ï¼ˆvirtualenv） ãƒãƒ¼ã‚«ãƒ«ã§ã®è¤‡æ•°ç’°å¢ƒã®ãƒ†ã‚¹ãƒˆå®¹æ˜“化（tox+pytest） CIã«ã‚ˆã‚‹ãƒ†ã‚¹ãƒˆï¼ˆTravis-CI） ドã‚ュメントã®è‡ªå‹•ãƒ“ルドãŠã‚ˆã³ãƒ‰ã‚ュメントã®å…¬é–‹ï¼ˆReadTheDocs） æ¦‚è¦ ã¨ã‚Šã‚ãˆãšå…¨ä½“åƒã‚’å…ˆã«å…±æœ‰ã—ã¦ãŠãã¾ã™ã€‚ã¡ã‚‡ã£ã¨ã§ã‹ã„ã§ã™ãŒã”了
1
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
src ã‹ã‚‰ rst ç”Ÿæˆ - Python Advent Calender 2013 11日目 — SXIMADA W3
redirecter
{{#tags}}- {{label}}
{{/tags}}