mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-10-12 16:32:10 -05:00
Migrate JavaScript tests from Karma to the Jasmine framework (#12754)
This commit is contained in:
1 parent
96b511798d
commit
e3238260f6
8 files changed
+1343
-1729
No files matched your search
@@ -174,10 +174,10 @@ Style and type checks can be run as follows:
|
||||
Unit tests
|
||||
~~~~~~~~~~
|
||||
|
||||
Sphinx is tested using pytest_ for Python code and Karma_ for JavaScript.
|
||||
Sphinx is tested using pytest_ for Python code and Jasmine_ for JavaScript.
|
||||
|
||||
.. _pytest: https://docs.pytest.org/en/latest/
|
||||
.. _Karma: https://karma-runner.github.io
|
||||
.. _Jasmine: https://jasmine.github.io/
|
||||
|
||||
To run Python unit tests, we recommend using :program:`tox`, which provides a number
|
||||
of targets and allows testing against multiple different Python environments:
|
||||
@@ -216,13 +216,10 @@ To run JavaScript tests, use :program:`npm`:
|
||||
|
||||
.. tip::
|
||||
|
||||
:program:`karma` requires a Firefox binary to use as a test browser.
|
||||
:program:`jasmine` requires a Firefox binary to use as a test browser.
|
||||
|
||||
For Unix-based systems, you can specify the path to the Firefox binary using:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
FIREFOX_BIN="/Applications/Firefox.app/Contents/MacOS/firefox" npm test
|
||||
On Unix systems, you can check the presence and location of the ``firefox``
|
||||
binary at the command-line by running ``command -v firefox``.
|
||||
|
||||
New unit tests should be included in the :file:`tests/` directory where necessary:
|
||||
|
||||
|
||||
Reference in new issue
Block a user