diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2017-03-18 12:25:50 +0300 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2017-03-18 12:25:50 +0300 |
| commit | aa6dfb8b411b68c497d2e7d7b18286a52f6d9cc6 (patch) | |
| tree | afb1b69f19ba62d109160dd50505389e7aca2f20 /CONTRIBUTING.rst | |
| parent | 0df0a11cfac651222513bff9426455d449f302c3 (diff) | |
| parent | 2dae11aa6800af78574d27d0bcc1f121b483c00a (diff) | |
Merge branch 'stable'
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 30dee2774..274bc994a 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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 |