タグ

関連タグで絞り込む (1)

タグの絞り込みを解除

sphinxとapiに関するmoqadaのブックマーク (1)

  • SphinxでPythonドキュメントを自動的にビルド - Qiita

    Pythonでは関数、クラス、メソッドで最初に現れた文字列リテラルを__doc__に代入し、あとからその関数の意味について調べることが出来ます。これは便利な機能ではあるのですが、しかしただPythonの対話型コンソール画面やIDE、あるいはPython向けの各種プラグインからしか引用できないとなると、とてももったいない。 そこで、Pythonistaがよくつかう、Sphinxというドキュメントツールを使うと、このDocstringをまとめて一つにしてくれます。そのコマンドがsphinx-apidocです。これの詳しい使い方については、公式ドキュメントを見ていただければと思います。上手くいけば、Sphinxのプロジェクトが立ち上がることでしょう。 さて、テスト駆動をやる上において、watchdogであったり、あるいはsnifferにテストをフックして、ファイルが更新されるたびに、テストを起動

    SphinxでPythonドキュメントを自動的にビルド - Qiita
  • 1