diff options
| author | Georg Brandl <georg@python.org> | 2011-01-04 12:40:19 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2011-01-04 12:40:19 +0100 |
| commit | 59fd20fdc35e353b362c799b8367ffd78608c40c (patch) | |
| tree | c00ea96a3fa8d857e3b262d4b33951850dea836a /doc/ext/appapi.rst | |
| parent | 77eedbb984a5ba6658625bbe605d9756ce410cb7 (diff) | |
| download | sphinx-59fd20fdc35e353b362c799b8367ffd78608c40c.tar.gz | |
#273: Add an API for adding full-text search support for languages other than English. Add support for Japanese.
Based on the implementation by SHIBUKAWA Yoshiki in https://bitbucket.org/shibu/sphinx/.
Diffstat (limited to 'doc/ext/appapi.rst')
| -rw-r--r-- | doc/ext/appapi.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/ext/appapi.rst b/doc/ext/appapi.rst index bbe2070f..aa314584 100644 --- a/doc/ext/appapi.rst +++ b/doc/ext/appapi.rst @@ -286,6 +286,15 @@ the following public API: .. versionadded:: 0.6 +.. method:: Sphinx.add_search_language(cls) + + Add *cls*, which must be a subclass of :class:`sphinx.search.SearchLanguage`, + as a support language for building the HTML full-text search index. The + class must have a *lang* attribute that indicates the language it should be + used for. See :confval:`html_search_language`. + + .. versionadded:: 1.1 + .. method:: Sphinx.connect(event, callback) Register *callback* to be called when *event* is emitted. For details on |