Add development memo about stemming JS code, acceleration tips about stemming, small bug fix

2 files changed, 21 insertions, 0 deletions

diff --git a/doc/config.rst b/doc/config.rst
index 260ccddd..2fd1cf66 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -747,6 +747,15 @@ that use Sphinx' HTMLWriter class.
    * ``sv`` -- Swedish
    * ``tr`` -- Turkish
 
+   .. admonition:: Accelerate build speed
+
+      Each language (except Japanese) provides its own stemming algorithm.
+      Sphinx uses Python implementation by default. You can use
+      C implementation to accelerate building the index file.
+
+      * `PorterStemmer <https://pypi.python.org/pypi/PorterStemmer>`_ (`en`)
+      * `PyStemmer <https://pypi.python.org/pypi/PyStemmer>`_ (all languages)
+
    .. versionadded:: 1.1
 
    .. versionchanged:: 1.3
diff --git a/doc/devguide.rst b/doc/devguide.rst
index fccdd3fa..666822d6 100644
--- a/doc/devguide.rst
+++ b/doc/devguide.rst
@@ -243,3 +243,15 @@ Debugging Tips
 
 * Set the debugging options in the `Docutils configuration file
   <http://docutils.sourceforge.net/docs/user/config.html>`_.
+
+* JavaScript stemming algorithms in `sphinx/search/*.py` (except `en.py`) are
+  genereted by
+  `modified snowballcode generator <https://github.com/shibukawa/snowball>`_.
+  Generated `JSX <http://jsx.github.io/>`_ files are
+  in `this repository <https://github.com/shibukawa/snowball-stemmer.jsx>`_.
+  You can get resulting JavaScript files by the following command:
+
+  .. code-block:: bash
+
+     $ npm install
+     $ node_modules/.bin/grunt build # -> dest/*.global.js