Fix sphinx-doc#9322: KeyError is raised on PropagateDescDomain transform #9334
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
PropageteDescDomain applies the domain name from the "domain" attribute of parent node (desc node) to the desc_signature node. The structure has longly generated by ObjectDescription. But it must not be a new rule. This allows to build document that contains non standard doctree.
tk0miya
changed the title
bneradt
approved these changes
Jun 14, 2021
There was a problem hiding this comment.
I verified this patch address the Traffic Server doc build issue (#9322). I reproduced #9322 locally with Sphinx==4.0.2 and Python 3.8.3. The KeyError for domain was raised. I then applied this patch locally and rebuilt the ATS docs. The docs build succeeded.
Thank you for turning a patch around so quickly.
|
Thank you for your confirmation :-) Just merged. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
of parent node (desc node) to the desc_signature node. The structure
has longly generated by ObjectDescription. But it must not be a new
rule.