summaryrefslogtreecommitdiff
path: root/doc/devguide.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/devguide.rst')
-rw-r--r--doc/devguide.rst12
1 files changed, 12 insertions, 0 deletions
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