From 5ed3f0ad52d92292702b78152a56d5f8132a7074 Mon Sep 17 00:00:00 2001
From: Timotheus Kampik <timotheus.kampik@gmail.com>
Date: Sun, 22 Jul 2018 20:20:32 +0200
Subject:  #5186 add contrib doc for JS tests

---
 CONTRIBUTING.rst | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

(limited to 'CONTRIBUTING.rst')

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 6736e4c72..19c03c496 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -154,6 +154,12 @@ These are the basic steps needed to start developing on Sphinx.
 
          tox -e docs -- -b html,latexpdf
 
+   * To run JavaScript tests with `Karma <https://karma-runner.github.io>`_,
+     execute the following commands (requires `Node.js <https://nodejs.org>`_)::
+
+      npm install
+      npm run test
+
    You can also test by installing dependencies in your local environment. ::
 
        pip install .[test]
@@ -302,8 +308,8 @@ Debugging Tips
   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
+     npm install
+     node_modules/.bin/grunt build # -> dest/*.global.js
 
 
 Branch Model
@@ -402,3 +408,6 @@ and other ``test_*.py`` files under ``tests`` directory.
 
 .. versionadded:: 1.6
    ``sphinx.testing`` as a experimental.
+
+.. versionadded:: 1.8
+   Sphinx also runs JavaScript tests.
-- 
cgit v1.2.3