{"id":925,"date":"2017-04-15T22:21:41","date_gmt":"2017-04-15T13:21:41","guid":{"rendered":"http:\/\/www.python.ambitious-engineer.com\/?p=925"},"modified":"2017-04-19T00:27:54","modified_gmt":"2017-04-18T15:27:54","slug":"sphinx%e5%85%a5%e9%96%80","status":"publish","type":"post","link":"https:\/\/www.python.ambitious-engineer.com\/archives\/925","title":{"rendered":"sphinx\u5165\u9580 \u305d\u306e1 \u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u306e\u81ea\u52d5\u751f\u6210"},"content":{"rendered":"

\u30e1\u30b8\u30e3\u30fc\u306a\u30d7\u30ed\u30b0\u30e9\u30e0\u8a00\u8a9e\u3067\u306f\u30d7\u30ed\u30b0\u30e9\u30e0\u306e\u30b3\u30e1\u30f3\u30c8\u304b\u3089\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u3092\u751f\u6210\u3059\u308b\u30e9\u30a4\u30d6\u30e9\u30ea\u304c\u3042\u308a\u307e\u3059\u3002\u4f8b\u3048\u3070java\u3060\u3068javadoc\u304c\u6709\u540d\u3067\u3059\u306d\u3002Python\u3067\u306fsphinx\u3068\u3044\u3046\u30e9\u30a4\u30d6\u30e9\u30ea\u3067\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u3092\u751f\u6210\u3059\u308b\u3053\u3068\u304c\u3067\u304d\u307e\u3059\u3002\u3053\u306e\u30da\u30fc\u30b8\u3067\u306fdocstring\u304b\u3089sphinx\u3092\u7528\u3044\u3066html\u306e\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u3092\u751f\u6210\u3057\u3066\u307f\u307e\u3057\u3087\u3046\u3002<\/p>\n

sphinx\u3068\u306f<\/h2>\n

sphinx\u3068\u306fPython\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u306e\u305f\u3081\u306b\u4f5c\u3089\u308c\u305fpython\u88fd\u306e\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u4f5c\u6210\u30c4\u30fc\u30eb\u3067\u3059\u3002reStructuredText(reST)\u3068\u3044\u3046\u5f62\u5f0f\u306e\u30de\u30fc\u30af\u30a2\u30c3\u30d7\u3067\u6271\u3044\u307e\u3059\u3002\u51fa\u529b\u306fweb\u3067\u53c2\u7167\u3067\u304d\u308bhtml\u5f62\u5f0f\u4ee5\u5916\u306b\u3001LaTex\u5f62\u5f0f\u7b49\u306b\u3082\u5bfe\u5fdc\u3057\u3066\u3044\u307e\u3059\u3002<\/p>\n

\u7c21\u5358\u306a\u4f7f\u3044\u65b9<\/h2>\n

\u3067\u306f\u30b5\u30f3\u30d7\u30eb\u3092\u901a\u3057\u3066\u7c21\u5358\u306a\u4f7f\u3044\u65b9\u306b\u3064\u3044\u3066\u5b66\u7fd2\u3057\u307e\u3057\u3087\u3046\u3002<\/p>\n

\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb<\/h3>\n

\u307e\u305a\u306f\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3067\u3059\u3002pip\u3067\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u53ef\u80fd\u3067\u3059\u3002<\/p>\n

\r\npip install sphinx\r\n<\/pre>\n
\u30b5\u30f3\u30d7\u30eb\u30d7\u30ed\u30b0\u30e9\u30e0<\/h3>\n
\u4ee5\u4e0b\u306e\u69cb\u6210\u306e\u30d7\u30ed\u30b0\u30e9\u30e0\u3092\u984c\u6750\u3068\u3057\u3066\u307f\u307e\u3059\u3002<\/p>\n
\r\n\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\r\n\u251c\u2500\u2500 docs # \u7a7a\u306e\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\r\n\u251c\u2500\u2500 html # \u7a7a\u306e\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\r\n\u2514\u2500\u2500 sample # \u30bd\u30fc\u30b9\r\n    \u251c\u2500\u2500 pkg # \u30d1\u30c3\u30b1\u30fc\u30b8\r\n    \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\r\n    \u2502\u00a0\u00a0 \u251c\u2500\u2500 __pycache__\r\n    \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.cpython-35.pyc\r\n    \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 mod1.cpython-35.pyc\r\n    \u2502\u00a0\u00a0 \u2514\u2500\u2500 mod1.py\r\n    \u2514\u2500\u2500 run.py\r\n<\/pre>\n
\u3068\u308a\u3042\u3048\u305apython\u30d5\u30a1\u30a4\u30eb\u306frun.py\u3001pkg\/__init__.py\u3001pkg\/__init__.py\u3001pkg\/mod1.py\u306e3\u3064\u7528\u610f\u3057\u3066\u307f\u307e\u3057\u3087\u3046\u304b\u3002\u307e\u305f\u3001rst\u30d5\u30a1\u30a4\u30eb\u306e\u305f\u3081\u306edocs\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u3068html\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u3092\u683c\u7d0d\u3059\u308bhtml\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u3092\u6e96\u5099\u3057\u307e\u3059\u3002<\/p>\n
run.py<\/strong><\/p>\n
\r\n# run.py\r\n"""\r\n    \u30e1\u30a4\u30f3\u51e6\u7406 \r\n    ~~~~~~~~~~~~~~~~~~\r\n\r\n    \u30e1\u30a4\u30f3\u306e\u51e6\u7406\u3092\u884c\u3046\u30b9\u30af\u30ea\u30d7\u30c8\u3067\u3059 \r\n\r\n    \u6982\u8981 \r\n    --------\r\n\r\n    pytho\u306e\u30c9\u30ad\u30e5\u30e1\u30f3\u30c6\u30fc\u30b7\u30e7\u30f3\u306e\u8aac\u660e\u7528\u306b\u4f5c\u308a\u307e\u3057\u305f::\r\n\r\n\r\n    :copyright: (c) 2017 by the Kuro.\r\n    :license: BSD, see LICENSE for more details.\r\n"""\r\n\r\nfrom pkg.mod1 import SampleClass\r\n\r\ndef main(arg):\r\n    """ \r\n    \u6587\u5b57\u5217\u3092\u88c5\u98fe\u3057\u3066\u8868\u793a\u3057\u307e\u3059 \r\n\r\n    :param arg: \u30d1\u30e9\u30e1\u30fc\u30bf \r\n    :return: \u6587\u5b57\u5217\r\n    """\r\n    obj = SampleClass(' ***** ')\r\n    text = obj.func1(arg)\r\n    print(text)\r\n\r\n\r\nif __name__ == '__main__':\r\n    main("python\u6700\u9ad8\uff01\uff01")\r\n\r\n<\/pre>\n
\npkg\/__init__.py<\/strong><\/p>\n
\r\n# pkg\/__init__.py\r\n"""\r\n    sample\u30d1\u30c3\u30b1\u30fc\u30b8 \r\n    ~~~~~~~~~~~~~~~~~~\r\n\r\n    sample\u30d1\u30c3\u30b1\u30fc\u30b8\u306e\u8aac\u660e\u6587\u3067\u3059 \r\n\r\n    \u6982\u8981 \r\n    --------\r\n\r\n    sample\u30d1\u30c3\u30b1\u30fc\u30b8\u3067\u3059::\r\n\r\n\r\n    :copyright: (c) 2017 by the Kuro.\r\n    :license: BSD, see LICENSE for more details.\r\n\r\n<\/pre>\n
\npkg\/mod1.py<\/strong><\/p>\n
\r\n# pkg\/mod1.py\r\n"""\r\nsample\u30e2\u30b8\u30e5\u30fc\u30eb sample\u30af\u30e9\u30b9\u7b49\u306e\u8aac\u660e\u6587\r\n"""\r\n\r\n\r\nclass SampleClass:\r\n    """\r\n    sample\u30af\u30e9\u30b9\u306e\u8aac\u660e\u6587\r\n    """\r\n\r\n    def __init__(self, arg):\r\n        """ \r\n        \u5f15\u6570\u306e\u6587\u5b57\u5217\u8868\u73fe\u306e\u524d\u5f8c\u3092\u88c5\u98fe\u3059\u308b \r\n\r\n        :param arg: \u30d1\u30e9\u30e1\u30fc\u30bf \r\n        :return: \u7d50\u679c\u6587\u5b57\u5217\r\n        """\r\n        self.d_str = arg\r\n\r\n    def func1(self, arg):\r\n        """ \r\n        \u5f15\u6570\u306e\u6587\u5b57\u5217\u8868\u73fe\u306e\u524d\u5f8c\u3092\u88c5\u98fe\u3059\u308b \r\n\r\n        :param arg: \u30d1\u30e9\u30e1\u30fc\u30bf \r\n        :return: \u7d50\u679c\u6587\u5b57\u5217\r\n        """\r\n        result = self.d_str + str(arg) + self.d_str \r\n        return result \r\n\r\n<\/pre>\n
rst\u306e\u751f\u6210<\/h3>\n
sphinx-apidoc\u30b3\u30de\u30f3\u30c9\u3092\u4ee5\u4e0b\u306e\u3088\u3046\u306b\u5b9f\u884c\u3057\u307e\u3059\u3002<\/p>\n
\r\nsphinx-apidoc -F -o .\/docs .\/sample\r\n<\/pre>\n
docs\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u306b\u30d5\u30a1\u30a4\u30eb\u304c\u751f\u6210\u3055\u308c\u3066\u3044\u308b\u3053\u3068\u304c\u78ba\u8a8d\u3067\u304d\u307e\u3059\u3002<\/p>\n
<\/p>\n
html\u306e\u751f\u6210<\/h3>\n
\u6700\u5f8c\u306bhtml\u3092\u751f\u6210\u3057\u307e\u3057\u3087\u3046\u3002\u305d\u306e\u524d\u306b\u3001\u524d\u306e\u51e6\u7406\u3067\u751f\u6210\u3055\u308c\u305fconf.py\u306e\u4ee5\u4e0b\u306e\u30b3\u30fc\u30c9\u306e\u30b3\u30e1\u30f3\u30c8\u30a2\u30a6\u30c8\u3092\u89e3\u9664\u3057\u307e\u3059\u3002<\/p>\n
\r\n# docs\/conf.py\r\nimport os\r\nimport sys\r\nsys.path.insert(0, '\/home\/....')\r\n<\/pre>\n
\u3067\u306f\u751f\u6210\u3067\u3059\u3002sphinx-build\u30b3\u30de\u30f3\u30c9\u3092\u4ee5\u4e0b\u306e\u3088\u3046\u306b\u5b9f\u884c\u3057\u307e\u3059\u3002html\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u914d\u4e0b\u306bhtml\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u304c\u751f\u6210\u3055\u308c\u307e\u3059\u3002<\/p>\n
\r\nsphinx-build -a .\/docs .\/html\r\n<\/pre>\n
\u751f\u6210\u3055\u308c\u305fhtml\u306e\u5185\u5bb9\u3092\u78ba\u8a8d\u3057\u3066\u307f\u307e\u3057\u3087\u3046\u3002\u30d6\u30e9\u30a6\u30b6html\/index.html\u3092\u78ba\u8a8d\u3059\u308b\u3068\u4ee5\u4e0b\u306e\u3088\u3046\u306a\u753b\u9762\u304c\u8868\u793a\u3055\u308c\u307e\u3059\u3002
\n\"\"<\/a><\/p>\n
\u30b3\u30de\u30f3\u30c9\u30aa\u30d7\u30b7\u30e7\u30f3<\/h2>\n
sphinx-apidoc<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\u30aa\u30d7\u30b7\u30e7\u30f3<\/th>\n\u610f\u5473<\/th>\n
-F<\/td>\nfull\u3067\u751f\u6210\u3057\u307e\u3059\u3002\u6307\u5b9a\u3057\u306a\u3044\u5834\u5408\u306frst\u30d5\u30a1\u30a4\u30eb\u306e\u307f\u751f\u6210\u3055\u308c\u307e\u3059\u3002<\/td>\n
-f<\/td>\n\u51fa\u529b\u6642\u306b\u5f37\u5236\u4e0a\u66f8\u304d\u3092\u3057\u307e\u3059\u3002<\/td>\n
-o<\/td>\n\u51fa\u529b\u5148\u3092\u6307\u5b9a\u3057\u307e\u3059\u3002<\/td>\n
-H<\/td>\n\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u540d\u3092\u6307\u5b9a\u3057\u307e\u3059\u3002<\/td>\n
-A<\/td>\nauthor\u3092\u6307\u5b9a\u3057\u307e\u3059\u3002<\/td>\n
-V<\/td>\nversion\u3092\u6307\u5b9a\u3057\u307e\u3059\u3002<\/td>\n
\n\u6700\u521d\u306e\u30b5\u30f3\u30d7\u30eb\u3067\u306f\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u540d\u306b\u30bd\u30fc\u30b9\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u540d\u304c\u8a2d\u5b9a\u3055\u308c\u307e\u3059\u304c\u3001\u4f8b\u3048\u3070\u30bd\u30fc\u30b9\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u304csrc\u306a\u3069\u306e\u5834\u5408\u306fH\u30aa\u30d7\u30b7\u30e7\u30f3\u3067\u8a2d\u5b9a\u3059\u308b\u3068\u826f\u3044\u3067\u3057\u3087\u3046\u3002<\/p>\n
sphinx-build<\/h3>\n
\u4ee5\u4e0b\u306e\u5f62\u5f0f\u3067\u8a18\u8ff0\u3057\u307e\u3059\u3002<\/p>\n
\r\nsphinx-build [options] \u5165\u529b\u5143 \u51fa\u529b\u5148 \r\n<\/pre>\n
\n\n\n\n\n\n\n<\/table>\n
tips<\/h2>\n
sphinx-apidoc\u3067\u3059\u304c\u30011\u56de\u3081\u306b-F\u30aa\u30d7\u30b7\u30e7\u30f3\u3092\u6307\u5b9a\u3057\u3066conf.py\u3092\u4fee\u6b63\u3057\u30012\u56de\u3081\u4ee5\u964d\u306f-F\u30aa\u30d7\u30b7\u30e7\u30f3\u3092\u4ed8\u3051\u308b\u3001\u3068\u3044\u3046\u65b9\u6cd5\u3067\u3082\u826f\u3044\u306e\u3067\u3059\u304c\u3001\u30b4\u30df\u304c\u6b8b\u3063\u305f\u308a\u30d3\u30eb\u30c9\u306e\u5931\u6557\u306b\u6c17\u3065\u304b\u306a\u304b\u3063\u305f\u308a\u3059\u308b\u306e\u3067\u3001\u79c1\u306f\u4ee5\u4e0b\u306e\u3088\u3046\u306brm\u3068sed\u3068\u7d44\u307f\u5408\u308f\u305b\u3066\u6bce\u56de\u5168\u90e8\u4f5c\u308a\u76f4\u3057\u3066\u3044\u307e\u3059\u3002linux\u3084mac\u3092\u5229\u7528\u3057\u3066\u3044\u308b\u65b9\u306f\u53c2\u8003\u306b\u3057\u3066\u304f\u3060\u3055\u3044\u3002<\/p>\n
\r\nrm -rf docs\/*\r\nrm -rf html\/*\r\nsphinx-apidoc -F -o .\/docs .\/sample\r\nsed -i -e 's\/# import os\/import os\/' docs\/conf.py\r\nsed -i -e 's\/# import sys\/import sys\/' docs\/conf.py\r\nsed -i -e 's\/# sys.path.insert\/sys.path.insert\/' docs\/conf.py\r\nsphinx-build -a .\/docs .\/html\r\n<\/pre>\n
\u305f\u3060\u3057\u3001\u5f8c\u8ff0\u3057\u307e\u3059\u304csphinx\u3067\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u3092\u81ea\u52d5\u751f\u6210\u3057\u305f\u3042\u3068\u3001rst\u30d5\u30a1\u30a4\u30eb\u3092\u624b\u52d5\u3067\u8ffd\u8a18\u3059\u308b\u3053\u3068\u304c\u591a\u3044\u3067\u3059\u3002\u305d\u306e\u5834\u5408\u306fls\u3001egrep\u3001xargs\u3092\u7d44\u307f\u5408\u308f\u305b\u3066\u7279\u5b9a\u30d5\u30a1\u30a4\u30eb\u306f\u524a\u9664\u3057\u306a\u3044\u3088\u3046\u306b\u3059\u308b\u5fc5\u8981\u304c\u3042\u308a\u307e\u3059\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"
\u30e1\u30b8\u30e3\u30fc\u306a\u30d7\u30ed\u30b0\u30e9\u30e0\u8a00\u8a9e\u3067\u306f\u30d7\u30ed\u30b0\u30e9\u30e0\u306e\u30b3\u30e1\u30f3\u30c8\u304b\u3089\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u3092\u751f\u6210\u3059\u308b\u30e9\u30a4\u30d6\u30e9\u30ea\u304c\u3042\u308a\u307e\u3059\u3002\u4f8b\u3048\u3070java\u3060\u3068javadoc\u304c\u6709\u540d\u3067\u3059\u306d\u3002Python\u3067\u306fsphinx\u3068\u3044\u3046\u30e9\u30a4\u30d6\u30e9\u30ea\u3067\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u3092\u751f\u6210\u3059\u308b\u3053\u3068\u304c\u3067\u304d...<\/p>\n","protected":false},"author":1,"featured_media":934,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[156],"tags":[157],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.python.ambitious-engineer.com\/wp-json\/wp\/v2\/posts\/925"}],"collection":[{"href":"https:\/\/www.python.ambitious-engineer.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.python.ambitious-engineer.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.python.ambitious-engineer.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.python.ambitious-engineer.com\/wp-json\/wp\/v2\/comments?post=925"}],"version-history":[{"count":8,"href":"https:\/\/www.python.ambitious-engineer.com\/wp-json\/wp\/v2\/posts\/925\/revisions"}],"predecessor-version":[{"id":946,"href":"https:\/\/www.python.ambitious-engineer.com\/wp-json\/wp\/v2\/posts\/925\/revisions\/946"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.python.ambitious-engineer.com\/wp-json\/wp\/v2\/media\/934"}],"wp:attachment":[{"href":"https:\/\/www.python.ambitious-engineer.com\/wp-json\/wp\/v2\/media?parent=925"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.python.ambitious-engineer.com\/wp-json\/wp\/v2\/categories?post=925"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.python.ambitious-engineer.com\/wp-json\/wp\/v2\/tags?post=925"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
\u30aa\u30d7\u30b7\u30e7\u30f3<\/th>\n\u610f\u5473<\/th>\n
-b<\/td>\n\u30d3\u30eb\u30c0\u30fc\uff08\u2252\u51fa\u529b\u5f62\u5f0f\uff09\u3092\u6307\u5b9a\u3057\u307e\u3059\u3002\u30c7\u30d5\u30a9\u30eb\u30c8\u3067\u306fhtml\u3067\u3059\u304c\u3001xml\u3001latex\u306a\u3069\u3092\u6307\u5b9a\u3059\u308b\u3053\u3068\u304c\u3067\u304d\u307e\u3059\u3002<\/td>\n
-a<\/td>\n\u3059\u3079\u3066\u306e\u51fa\u529b\u30d5\u30a1\u30a4\u30eb\u3092\u66f8\u304d\u51fa\u3057\u307e\u3059\u3002\u3053\u306e\u30aa\u30d7\u30b7\u30e7\u30f3\u3092\u3064\u3051\u306a\u3044\u5834\u5408\u306f\u65b0\u898f\u306b\u4f5c\u6210\u3055\u308c\u305f\u308a\u3001\u5909\u66f4\u306e\u3042\u3063\u305f\u30bd\u30fc\u30b9\u30d5\u30a1\u30a4\u30eb\u306b\u95a2\u9023\u3059\u308b\u51fa\u529b\u30d5\u30a1\u30a4\u30eb\u3060\u3051\u3092\u51fa\u529b\u3057\u307e\u3059\u3002<\/td>\n