🔧 Consolidate needs data post-processing #1039
Merged
Conversation
This file contains 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
|
#1036 got accepted and is ready for merge. After that I review this PR :) |
chrisjsewell
force-pushed
the
consolidate-need-post-processing
branch
from
5975f2f to
a27b71b
Compare
chrisjsewell
commented
Sep 28, 2023
| create_back_links(env, links["option"]) | ||
|
|
||
| process_constraints(app) | ||
| if not needs_data.needs_is_post_processed: |
There was a problem hiding this comment.
This is the main change; we move all needs post-processing under a single if block, which only gets run once (not for every document)
chrisjsewell
commented
Sep 28, 2023
| # We call process_needextend here by our own, so that we are able | ||
| # to give print_need_nodes the already found need_nodes. | ||
| process_needextend(app, doctree, fromdocname) | ||
| for extend_node in doctree.findall(Needextend): |
There was a problem hiding this comment.
This is split out from the original process_needextend function, since it is not part of the needs data post-processing
chrisjsewell
commented
Sep 28, 2023
| check_links(env) | ||
| create_back_links(env) | ||
| process_constraints(app) | ||
| extend_needs_data(app) |
There was a problem hiding this comment.
This is process_needextend, but with the removal of nodes
chrisjsewell
commented
Sep 28, 2023
| resolve_dynamic_values(env) | ||
| resolve_variants_options(env) | ||
| check_links(env) | ||
| create_back_links(env) |
There was a problem hiding this comment.
looping through all link types is also moved internal to the create_back_links function
danwos
approved these changes
Sep 28, 2023
iSOLveIT
pushed a commit
that referenced
this pull request
Oct 24, 2023
This commit is a step towards being able to generate the needs.json without running the Sphinx `BUILD` phase. Here we consolidate all functions that post-process the needs data, after it has been fully extracted from all documents and external sources. We remove the individual logic from within these functions, to check if the post-processing has already been done, and instead check before running all the functions. This refactor does not actually change the sphinx-needs process in any way, this will come later.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR is a step towards #1018, and being able to generate the
needs.jsonwithout running the SphinxBUILDphase.Here we consolidate all functions that post-process the needs data, after it has been fully extracted from all documents and external sources.
We remove the individual logic from within these functions, to check if the post-processing has already been done, and instead check before running all the functions.
This refactor does not actually change the sphinx-needs process in any way, this will come in later PRs