diff options
| author | Dmitry Shachnev <mitya57@users.noreply.github.com> | 2022-10-24 03:07:05 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-24 03:07:05 +0300 |
| commit | 93215f0a64a2e27656ff2bfe6958a20b1e6b6e1e (patch) | |
| tree | 71b41e719f85f19c3466d6540811a5b45bdf8bb7 | |
| parent | b90bf8d193a4d571957a50db66c825e059549607 (diff) | |
doc: Actualize information about generating snowball JS files (#10931)
| -rw-r--r-- | doc/internals/contributing.rst | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/doc/internals/contributing.rst b/doc/internals/contributing.rst index 33c279e2b..833ed7d33 100644 --- a/doc/internals/contributing.rst +++ b/doc/internals/contributing.rst @@ -326,12 +326,11 @@ Debugging tips * Set the debugging options in the `Docutils configuration file <https://docutils.sourceforge.io/docs/user/config.html>`_. -* JavaScript stemming algorithms in ``sphinx/search/*.py`` (except ``en.py``) - are generated by this `modified snowballcode generator - <https://github.com/shibukawa/snowball>`_. Generated `JSX - <https://jsx.github.io/>`_ files are in `this repository - <https://github.com/shibukawa/snowball-stemmer.jsx>`_. You can get the - resulting JavaScript files using the following command:: - - npm install - node_modules/.bin/grunt build # -> dest/*.global.js +* JavaScript stemming algorithms in ``sphinx/search/non-minified-js/*.js`` + are generated using `snowball <https://github.com/snowballstem/snowball>`_ + by cloning the repository, executing ``make dist_libstemmer_js`` and then + unpacking the tarball which is generated in ``dist`` directory. + + Minified files in ``sphinx/search/minified-js/*.js`` are generated from + non-minified ones using ``uglifyjs`` (installed via npm), with ``-m`` + option to enable mangling. |