タグ

tipsとsphinxに関するh1saoのブックマーク (2)

  • Sphinxの全文検索を複合語に強くする

    最近社内のドキュメントは殆どSphinxで書いてます。しかしどうも検索の精度が悪い、特に複合語がヒットしないと言われたので改善してみました。Sphinxのバージョンはv1.2.2です。 まずはドキュメントに全文検索機能を追加する こんな方法で追加しました。 sphinx-quickstartでドキュメント作成 conf.pyに全文検索の設定を追加 python html_search_language = 'ja' html_search_options = {'type':'default'} # build server using type:mecab

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

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

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