[tests] JavaScript: developer/test-facing tweaks to fixture generation. #12531
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Check for presence of ``conf.py`` in potential fixture root directories. * Copy ``searchindex.js`` instead of moving it, so that the ``_build`` dir remains a valid, complete project build.
…as recommended by ``ruff``.
AA-Turner
reviewed
Jul 10, 2024
AA-Turner
approved these changes
Jul 10, 2024
…ead of reading and writing entire ``searchindex.js`` files during fixture generation. Co-authored-by: Adam Turner <[email protected]>
Relates-to commit 3e4c17a.
Member
|
Thanks! |
Contributor
Author
|
Thank you! |
jayaddison
deleted the
pr-12102-followup/developer-experience-improvements
branch
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature or Bugfix
Purpose
gitbranches when developing/testing changes that relate to the JavaScript test fixtures (added in [tests] JavaScript: extract searchindex.js-format test fixtures. #12102).Detail
searchindex.jsfile built by theutils/generate_js_fixtures.pyscript, copy it into the fixtures dir. This means that each built project remains as a complete Sphinxhtmlproject build output (and can, for example, be hosted in a local webserver to test behaviour).conf.pyfile when iterating through the local directories that are considered possible sources of JS test fixtures. When switching branches usinggit, some previous-branch directories may not be removed, even when the files within are cleared -- and without this change, theutils/generate_js_fixtures.pyscript andtest_check_js_search_indexestest case would try to build from those empty dirs (and fail).Relates
cc @wlach
Edit: clarify that the util script builds multiple projects