IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

refactor LaTeXTranslator; Replace _make_visit_admonition()

Browse Source
This commit is contained in:
Takeshi KOMIYA 2018-12-04 01:04:53 +09:00
parent 97615beda2
commit f5b7d24003
3 changed files with 32 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@ -52,6 +52,7 @@ Deprecated
* ``sphinx.util.osutil.walk()`` * ``sphinx.util.osutil.walk()``
* ``sphinx.util.pycompat.u`` * ``sphinx.util.pycompat.u``
* ``sphinx.writers.latex.LaTeXTranslator.babel_defmacro()`` * ``sphinx.writers.latex.LaTeXTranslator.babel_defmacro()``
* ``sphinx.writers.latex.TextTranslator._make_visit_admonition()``
* ``sphinx.writers.text.TextTranslator._make_depart_admonition()`` * ``sphinx.writers.text.TextTranslator._make_depart_admonition()``
* template variables for LaTeX template * template variables for LaTeX template

5
doc/extdev/index.rst
View File

@ -187,6 +187,11 @@ The following is a list of deprecated interfaces.
- 3.0 - 3.0
- N/A - N/A
* - ``sphinx.writers.latex.LaTeXTranslator._make_visit_admonition()``
- 2.0
- 3.0
- N/A
* - ``sphinx.writers.text.TextTranslator._make_depart_admonition()`` * - ``sphinx.writers.text.TextTranslator._make_depart_admonition()``
- 2.0 - 2.0
- 3.0 - 3.0

39
sphinx/writers/latex.py
View File

@ -1811,35 +1811,33 @@ class LaTeXTranslator(SphinxTranslator):
# type: (nodes.admonition) -> None # type: (nodes.admonition) -> None
self.body.append('\\end{sphinxadmonition}\n') self.body.append('\\end{sphinxadmonition}\n')
def _make_visit_admonition(name): def _visit_named_admonition(self, node):
# type: (unicode) -> Callable[[LaTeXTranslator, nodes.Element], None]
def visit_admonition(self, node):
# type: (nodes.Element) -> None # type: (nodes.Element) -> None
label = admonitionlabels[node.tagname]
self.body.append(u'\n\\begin{sphinxadmonition}{%s}{%s:}' % self.body.append(u'\n\\begin{sphinxadmonition}{%s}{%s:}' %
(name, admonitionlabels[name])) (node.tagname, label))
return visit_admonition
def _depart_named_admonition(self, node): def _depart_named_admonition(self, node):
# type: (nodes.Node) -> None # type: (nodes.Element) -> None
self.body.append('\\end{sphinxadmonition}\n') self.body.append('\\end{sphinxadmonition}\n')
visit_attention = _make_visit_admonition('attention') visit_attention = _visit_named_admonition
depart_attention = _depart_named_admonition depart_attention = _depart_named_admonition
visit_caution = _make_visit_admonition('caution') visit_caution = _visit_named_admonition
depart_caution = _depart_named_admonition depart_caution = _depart_named_admonition
visit_danger = _make_visit_admonition('danger') visit_danger = _visit_named_admonition
depart_danger = _depart_named_admonition depart_danger = _depart_named_admonition
visit_error = _make_visit_admonition('error') visit_error = _visit_named_admonition
depart_error = _depart_named_admonition depart_error = _depart_named_admonition
visit_hint = _make_visit_admonition('hint') visit_hint = _visit_named_admonition
depart_hint = _depart_named_admonition depart_hint = _depart_named_admonition
visit_important = _make_visit_admonition('important') visit_important = _visit_named_admonition
depart_important = _depart_named_admonition depart_important = _depart_named_admonition
visit_note = _make_visit_admonition('note') visit_note = _visit_named_admonition
depart_note = _depart_named_admonition depart_note = _depart_named_admonition
visit_tip = _make_visit_admonition('tip') visit_tip = _visit_named_admonition
depart_tip = _depart_named_admonition depart_tip = _depart_named_admonition
visit_warning = _make_visit_admonition('warning') visit_warning = _visit_named_admonition
depart_warning = _depart_named_admonition depart_warning = _depart_named_admonition
def visit_versionmodified(self, node): def visit_versionmodified(self, node):
@ -2663,6 +2661,17 @@ class LaTeXTranslator(SphinxTranslator):
return ('%s\\def%s{%s}%s\n' % (prefix, name, definition, suffix)) return ('%s\\def%s{%s}%s\n' % (prefix, name, definition, suffix))
def _make_visit_admonition(name):
# type: (unicode) -> Callable[[LaTeXTranslator, nodes.Element], None]
warnings.warn('LaTeXTranslator._make_visit_admonition() is deprecated.',
RemovedInSphinx30Warning)
def visit_admonition(self, node):
# type: (nodes.Element) -> None
self.body.append(u'\n\\begin{sphinxadmonition}{%s}{%s:}' %
(name, admonitionlabels[name]))
return visit_admonition
# Import old modules here for compatibility # Import old modules here for compatibility
# They should be imported after `LaTeXTranslator` to avoid recursive import. # They should be imported after `LaTeXTranslator` to avoid recursive import.
# #