singlebuilder: unique identifiers for merged doctree #1049
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
The following moves the compat-held `inline_all_toctrees` call into the builder itself. The original intent was to submit an upstream change to support inlining with toctree replacement support. This was never pushed on, so leaving it in the compat module is no longer required. There are additional changes planned to be made to the inlining process, to moving it now will ready the implementation for these prospect changes. Signed-off-by: James Knight <[email protected]>
When merging multiple doctrees into a single one, elements may have conflicting reference identifiers. This can lead to conflicting raw anchors as well as other logic in translators to create unexpected links when running the `singleconfluence` builder. This commit updates the merging process to replace the identifiers of each doctree element when a conflict is detected. Elements will be given a new identifier value, as well as elements referencing other elements will have their reference identifiers updated as well. Signed-off-by: James Knight <[email protected]>
Adding a unit test that verifies that generates anchors are unique for a page, as well as references for merge pages properly link to expected anchor points. Signed-off-by: James Knight <[email protected]>
Signed-off-by: James Knight <[email protected]>
Adds a run of the `singleconfluence` builder into the validation set. This can be helpful to verify the use of this builders during development, as well as present to users who want to verify capabilities and report observed issues that may have been overlooked. Signed-off-by: James Knight <[email protected]>
jdknight
force-pushed
the
unique-references-for-singleconfluence
branch
from
4a5fa4a
to
a021298
Compare
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.
When merging multiple doctrees into a single one, elements may have conflicting reference identifiers. This can lead to conflicting raw anchors as well as other logic in translators to create unexpected links when running the
singleconfluencebuilder.This commit updates the merging process to replace the identifiers of each doctree element when a conflict is detected. Elements will be given a new identifier value, as well as elements referencing other elements will have their reference identifiers updated as well.