WebSupportクラス¶
- class sphinxcontrib.websupport.WebSupport¶
ウェブサポートパッケージのメインとなるAPIクラスです。ウェブサポートパッケージに対して行われる、すべてのインタラクションは、このクラスを通じて行われます。
このクラスは、次のようなキーワード引数を取ります:
- srcdir
reStructuredTextのソースファイルを含むディレクトリです。
- builddir
ビルド済みのデータや、静的ファイルを置くべきディレクトリです。これはデータをビルドする
WebSupportオブジェクトを作る時に使用されます。- datadir
ウェブサポートのデータが置かれるディレクトリです。このデータを読み込む
WebSupportオブジェクトが作成されるときに使用されます。- search
これは組み込みの検索アダプタを参照するための文字列(例: 'xapian')か、
BaseSearchクラスのサブクラスのインスタンスを指定します。- storage
これはデータベースのURIを表す文字列、もしくは
StorageBackendのサブクラスのインスタンスを指定します。もしどちらも指定されなかった場合には、新しいsqliteデータベースが作られます。- moderation_callback
非表示の新しいコメントが追加されたときに呼び出されるコールバックです。この関数には、追加されたコメントを表す引数が1つ渡されます。
- staticdir
静的ファイルを
'/static'ではなく 別の場所に作成する必要がある場合、これはその場所の名前の文字列でなければなりません(例えばbuilddir + '/static_files'のようになります。)。注釈
staticdirを指定した場合、通常はそれに応じてstaticrootを調整します。- staticroot
静的ファイルが提供されるのが、
'/static'でない場合には、その場所の名前を表す文字列(例:'/static_files')を指定します。- docroot
ドキュメントがURLのベースパスから送信されない場合には、そのパスを表す文字(例:
'docs')を指定します。
バージョン 1.6 で変更: WebSupport クラスは、 sphinx.websupportからsphinxcontrib.websupport に移されました。 依存関係があるものに対して``sphinxcontrib-websupport``パッケージを追加し、移行されたクラスを代わりに使うようにしてください。