SphinxでPythonドキュメントを自動的にビルド - Qiita
Pythonでは関数、クラス、メソッドで最初に現れた文字列リテラルを__doc__に代入し、あとからその関数の意味について調べることが出来ます。これは便利な機能ではあるのですが、しかしただPythonの対話型コンソール画面やIDE、あるいはPython向けの各種プラグインからしか引用できないとなると、とてももったいない。 そこで、Pythonistaがよくつかう、Sphinxというドキュメントツールを使うと、このDocstringをまとめて一つにしてくれます。そのコマンドがsphinx-apidocです。これの詳しい使い方については、公式ドキュメントを見ていただければと思います。上手くいけば、Sphinxのプロジェクトが立ち上がることでしょう。 さて、テスト駆動をやる上において、watchdogであったり、あるいはsnifferにテストをフックして、ファイルが更新されるたびに、テストを起動
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の
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
