Merge branch 'stable'

This commit is contained in:
Takeshi KOMIYA
2017-03-18 18:25:50 +09:00
8 changed files with 93 additions and 59 deletions

View File

@@ -1,3 +1,5 @@
.. highlight:: console
Sphinx Developer's Guide
========================
@@ -129,8 +131,8 @@ These are the basic steps needed to start developing on Sphinx.
* Run code style checks and type checks (type checks require mypy)::
make style-check
make type-check
make style-check
make type-check
* Run the unit tests under different Python environments using
:program:`tox`::
@@ -274,14 +276,12 @@ 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
* JavaScript stemming algorithms in ``sphinx/search/*.py`` (except ``en.py``) are
generated by this
`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 the resulting JavaScript files using the following command:
.. code-block:: bash
You can get the resulting JavaScript files using the following command::
$ npm install
$ node_modules/.bin/grunt build # -> dest/*.global.js