diff options
| author | Timotheus Kampik <timotheus.kampik@gmail.com> | 2018-07-22 21:20:32 +0300 |
|---|---|---|
| committer | Timotheus Kampik <timotheus.kampik@gmail.com> | 2018-07-22 21:51:14 +0300 |
| commit | 5ed3f0ad52d92292702b78152a56d5f8132a7074 (patch) | |
| tree | ec5da29e3183f5a61d8a038ccf346606c14fc2fb /CONTRIBUTING.rst | |
| parent | 2fa382673fd36bd4701ad63beefa2e66c33358c3 (diff) | |
#5186 add contrib doc for JS tests
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 13 |
1 files changed, 11 insertions, 2 deletions
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. |