diff options
Diffstat (limited to 'doc/internals/contributing.rst')
| -rw-r--r-- | doc/internals/contributing.rst | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/internals/contributing.rst b/doc/internals/contributing.rst index 207374e..eac3560 100644 --- a/doc/internals/contributing.rst +++ b/doc/internals/contributing.rst @@ -156,7 +156,7 @@ Please follow these guidelines when writing code for Sphinx: Style and type checks can be run as follows:: - ruff . + ruff check . mypy sphinx/ Unit tests @@ -338,3 +338,9 @@ Debugging tips Minified files in ``sphinx/search/minified-js/*.js`` are generated from non-minified ones using ``uglifyjs`` (installed via npm), with ``-m`` option to enable mangling. + +* The ``searchindex.js`` files found in the ``tests/js/fixtures/*`` directories + are generated by using the standard Sphinx HTML builder on the corresponding + input projects found in ``tests/js/roots/*``. The fixtures provide test data + used by the Sphinx JavaScript unit tests, and can be regenerated by running + the ``utils/generate_js_fixtures.py`` script. |