これで,いくつかのsphinxコマンド(sphinx-apidoc,sphinx-autogen,sphinx-build,sphinx-quickstart)が使えるようになります. ドキュメントを抽出したいpythonファイルの準備 main.pyを作り,以下を記述します. """で囲まれた部分がdocstringと呼ばれる部分で,クラスやメソッドの注釈を入れることができます. docstringの記法にはReStructuredTextスタイル,Numpyスタイル,Googleスタイルなどがありますが,今回はGoogleスタイルで書きます. class TestClass: """Summary line. """ def testfunc(self, x, y): """sum Args: x (int): 1st argument y (int): 2nd argument Re
![Sphinxの使い方.docstringを読み込んで仕様書を生成 - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/31e0d25e2892cd595208c9a7d7b215dfbd350718/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-412672c5f0600ab9a64263b751f1bc81.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTk3MiZoPTM3OCZ0eHQ9U3BoaW54JUUzJTgxJUFFJUU0JUJEJUJGJUUzJTgxJTg0JUU2JTk2JUI5JUVGJUJDJThFZG9jc3RyaW5nJUUzJTgyJTkyJUU4JUFBJUFEJUUzJTgxJUJGJUU4JUJFJUJDJUUzJTgyJTkzJUUzJTgxJUE3JUU0JUJCJTk1JUU2JUE3JTk4JUU2JTlCJUI4JUUzJTgyJTkyJUU3JTk0JTlGJUU2JTg4JTkwJnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9NTYmcz00ZjVmMGU1ZTlhYTIwNzQ0ZDc2MjBmY2FlZTA1NWM2Zg%26mark-x%3D142%26mark-y%3D57%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZoPTc2Jnc9NzcwJnR4dD0lNDBmdXRha3VjaGkwMTE3JnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9MzYmdHh0LWFsaWduPWxlZnQlMkN0b3Amcz0zMzA0ZmU4MDUxYzM2MjZkYzA1ODUwMjJjZGFiOWI1Mw%26blend-x%3D142%26blend-y%3D486%26blend-mode%3Dnormal%26s%3Dc88cd559cb725fcf4c85b2b56d3d1f8b)