Skip to content

Commit

Permalink
Fix #8936: LaTeX: A custom LaTeX builder fails with unknown node error
Browse files Browse the repository at this point in the history
At present, post transform components for LaTeX builder does not work
for the custom LaTeX builder that inherits the original LaTeX builder.
This allows them working with the custom LaTeX builders.
  • Loading branch information
tk0miya committed Mar 4, 2021
1 parent 99d97c6 commit f75e86d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
2 changes: 2 additions & 0 deletions CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Features added
Bugs fixed
----------

* #8936: LaTeX: A custom LaTeX builder fails with unknown node error

Testing
--------

Expand Down
18 changes: 9 additions & 9 deletions sphinx/builders/latex/transforms.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class SubstitutionDefinitionsRemover(SphinxPostTransform):

# should be invoked after Substitutions process
default_priority = Substitutions.default_priority + 1
builders = ('latex',)
formats = ('latex',)

def run(self, **kwargs: Any) -> None:
for node in self.document.traverse(nodes.substitution_definition):
Expand All @@ -57,7 +57,7 @@ class ShowUrlsTransform(SphinxPostTransform):
.. note:: This transform is used for integrated doctree
"""
default_priority = 400
builders = ('latex',)
formats = ('latex',)

# references are expanded to footnotes (or not)
expanded = False
Expand Down Expand Up @@ -345,7 +345,7 @@ class LaTeXFootnoteTransform(SphinxPostTransform):
"""

default_priority = 600
builders = ('latex',)
formats = ('latex',)

def run(self, **kwargs: Any) -> None:
footnotes = list(self.document.traverse(nodes.footnote))
Expand Down Expand Up @@ -497,7 +497,7 @@ class BibliographyTransform(SphinxPostTransform):
...
"""
default_priority = 750
builders = ('latex',)
formats = ('latex',)

def run(self, **kwargs: Any) -> None:
citations = thebibliography()
Expand All @@ -516,7 +516,7 @@ class CitationReferenceTransform(SphinxPostTransform):
pending_xref nodes to citation_reference.
"""
default_priority = 5 # before ReferencesResolver
builders = ('latex',)
formats = ('latex',)

def run(self, **kwargs: Any) -> None:
domain = cast(CitationDomain, self.env.get_domain('citation'))
Expand All @@ -536,7 +536,7 @@ class MathReferenceTransform(SphinxPostTransform):
nodes to math_reference.
"""
default_priority = 5 # before ReferencesResolver
builders = ('latex',)
formats = ('latex',)

def run(self, **kwargs: Any) -> None:
equations = self.env.get_domain('math').data['objects']
Expand All @@ -551,7 +551,7 @@ def run(self, **kwargs: Any) -> None:
class LiteralBlockTransform(SphinxPostTransform):
"""Replace container nodes for literal_block by captioned_literal_block."""
default_priority = 400
builders = ('latex',)
formats = ('latex',)

def run(self, **kwargs: Any) -> None:
matcher = NodeMatcher(nodes.container, literal_block=True)
Expand All @@ -563,7 +563,7 @@ def run(self, **kwargs: Any) -> None:
class DocumentTargetTransform(SphinxPostTransform):
"""Add :doc label to the first section of each document."""
default_priority = 400
builders = ('latex',)
formats = ('latex',)

def run(self, **kwargs: Any) -> None:
for node in self.document.traverse(addnodes.start_of_file):
Expand Down Expand Up @@ -599,7 +599,7 @@ class IndexInSectionTitleTransform(SphinxPostTransform):
...
"""
default_priority = 400
builders = ('latex',)
formats = ('latex',)

def run(self, **kwargs: Any) -> None:
for node in self.document.traverse(nodes.title):
Expand Down

0 comments on commit f75e86d

Please sign in to comment.