From e3b817da2fe1d8179bae4025fc44a1062054f734 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 8 Jun 2016 01:27:22 +0900 Subject: [PATCH] Show warnings if unknown key is specified to `latex_elements` (ref: 2637) --- CHANGES | 1 + sphinx/writers/latex.py | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/CHANGES b/CHANGES index a20542cae6..8755b4421d 100644 --- a/CHANGES +++ b/CHANGES @@ -17,6 +17,7 @@ Features added * #2463, #2516: Add keywords of "meta" directive to search index * ``:maxdepth:`` option of toctree affects ``secnumdepth`` (ref: #2547) * #2575: Now ``sphinx.ext.graphviz`` allows ``:align:`` option +* Show warnings if unknown key is specified to `latex_elements` Bugs fixed ---------- diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 0296f56bd4..b54161dbce 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -458,6 +458,7 @@ class LaTeXTranslator(nodes.NodeVisitor): self.elements['contentsname'] = \ self.babel_renewcommand('\\contentsname', document.settings.contentsname) # allow the user to override them all + self.check_latex_elements() self.elements.update(builder.config.latex_elements) if self.elements['extraclassoptions']: self.elements['classoptions'] += ',' + \ @@ -505,6 +506,12 @@ class LaTeXTranslator(nodes.NodeVisitor): def pop_hyperlink_ids(self, figtype): return self.next_hyperlink_ids.pop(figtype, set()) + def check_latex_elements(self): + for key in self.builder.config.latex_elements: + if key not in self.elements: + msg = _("Unknown configure key: latex_elements[%r] is ignored.") + self.builder.warn(msg % key) + def restrict_footnote(self, node): if self.footnote_restricted is False: self.footnote_restricted = node