summaryrefslogtreecommitdiff
path: root/doc/config.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2013-01-04 11:17:32 +0100
committerGeorg Brandl <georg@python.org>2013-01-04 11:17:32 +0100
commit49766d3c533dcd55c6496215cb7de45741172d9a (patch)
tree94c092d7c610706705a8c5cde409860cd6c45b76 /doc/config.rst
parent1bd15df78fadbbca09d9c8a4d4c8f8bbe451c9d0 (diff)
downloadsphinx-49766d3c533dcd55c6496215cb7de45741172d9a.tar.gz
Closes #1067: implement pluggable search scorer and tweak scoring to give good results. Patch by Hernan Grecco.
Diffstat (limited to 'doc/config.rst')
-rw-r--r--doc/config.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst
index 0ff6d405..6174d487 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -760,6 +760,15 @@ that use Sphinx' HTMLWriter class.
.. versionadded:: 1.1
+.. confval:: html_search_scorer
+
+ The name of a javascript file (relative to the configuration directory) that
+ implements a search results scorer. If empty, the default will be used.
+
+ .. XXX describe interface for scorer here
+
+ .. versionadded:: 1.2
+
.. confval:: htmlhelp_basename
Output file base name for HTML help builder. Default is ``'pydoc'``.