diff --git a/CHANGES b/CHANGES index fb3b9450a..1e3558dad 100644 --- a/CHANGES +++ b/CHANGES @@ -104,11 +104,13 @@ Deprecated * ``sphinx.writers.latex.LaTeXTranslator._make_visit_admonition()`` * ``sphinx.writers.latex.LaTeXTranslator.babel_defmacro()`` * ``sphinx.writers.latex.LaTeXTranslator.collect_footnotes()`` +* ``sphinx.writers.latex.LaTeXTranslator.generate_numfig_format()`` * ``sphinx.writers.texinfo.TexinfoTranslator._make_visit_admonition()`` * ``sphinx.writers.text.TextTranslator._make_depart_admonition()`` * template variables for LaTeX template - ``logo`` + - ``numfig_format`` - ``pageautorefname`` - ``translatablestrings`` diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 795d0610c..dcfd4fbd7 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -459,6 +459,11 @@ The following is a list of deprecated interfaces. - 3.0 - N/A + * - ``sphinx.writers.latex.LaTeXTranslator.generate_numfig_format()`` + - 2.0 + - 4.0 + - N/A + * - :rst:dir:`highlightlang` - 1.8 - 4.0 diff --git a/sphinx/templates/latex/latex.tex_t b/sphinx/templates/latex/latex.tex_t index 6905b890b..2beac82c9 100644 --- a/sphinx/templates/latex/latex.tex_t +++ b/sphinx/templates/latex/latex.tex_t @@ -46,7 +46,6 @@ <%= hyperref %> <%= contentsname %> -<%= numfig_format %> \usepackage{sphinxmessages} <%= tocdepth %> <%= secnumdepth %> diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 210ceaa94..222bad53a 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -151,7 +151,6 @@ DEFAULT_SETTINGS = { '\\usepackage{hypcap}% it must be loaded after hyperref.\n' '% Set up styles of URL: it should be placed after hyperref.\n' '\\urlstyle{same}'), - 'numfig_format': '', 'contentsname': '', 'preamble': '', 'title': '', @@ -621,7 +620,6 @@ class LaTeXTranslator(SphinxTranslator): if self.elements['extraclassoptions']: self.elements['classoptions'] += ',' + \ self.elements['extraclassoptions'] - self.elements['numfig_format'] = self.generate_numfig_format(self.builder) self.highlighter = highlighting.PygmentsBridge('latex', self.config.pygments_style) self.context = [] # type: List[Any] @@ -722,46 +720,6 @@ class LaTeXTranslator(SphinxTranslator): return ('%s\\renewcommand{%s}{%s}%s\n' % (prefix, command, definition, suffix)) - def generate_numfig_format(self, builder): - # type: (LaTeXBuilder) -> str - ret = [] # type: List[str] - figure = self.builder.config.numfig_format['figure'].split('%s', 1) - if len(figure) == 1: - ret.append('\\def\\fnum@figure{%s}\n' % - str(figure[0]).strip().translate(tex_escape_map)) - else: - definition = str(figure[0]).strip().translate(tex_escape_map) - ret.append(self.babel_renewcommand('\\figurename', definition)) - if figure[1]: - ret.append('\\makeatletter\n') - ret.append('\\def\\fnum@figure{\\figurename\\thefigure%s}\n' % - str(figure[1]).strip().translate(tex_escape_map)) - ret.append('\\makeatother\n') - - table = self.builder.config.numfig_format['table'].split('%s', 1) - if len(table) == 1: - ret.append('\\def\\fnum@table{%s}\n' % - str(table[0]).strip().translate(tex_escape_map)) - else: - definition = str(table[0]).strip().translate(tex_escape_map) - ret.append(self.babel_renewcommand('\\tablename', definition)) - if table[1]: - ret.append('\\makeatletter\n') - ret.append('\\def\\fnum@table{\\tablename\\thetable%s}\n' % - str(table[1]).strip().translate(tex_escape_map)) - ret.append('\\makeatother\n') - - codeblock = self.builder.config.numfig_format['code-block'].split('%s', 1) - if len(codeblock) == 1: - pass # FIXME - else: - definition = str(codeblock[0]).strip().translate(tex_escape_map) - ret.append(self.babel_renewcommand('\\literalblockname', definition)) - if codeblock[1]: - pass # FIXME - - return ''.join(ret) - def generate_indices(self): # type: () -> str def generate(content, collapsed): @@ -2603,5 +2561,48 @@ class LaTeXTranslator(SphinxTranslator): (name, admonitionlabels[name])) return visit_admonition + def generate_numfig_format(self, builder): + # type: (LaTeXBuilder) -> str + warnings.warn('generate_numfig_format() is deprecated.', + RemovedInSphinx40Warning) + ret = [] # type: List[str] + figure = self.builder.config.numfig_format['figure'].split('%s', 1) + if len(figure) == 1: + ret.append('\\def\\fnum@figure{%s}\n' % + str(figure[0]).strip().translate(tex_escape_map)) + else: + definition = str(figure[0]).strip().translate(tex_escape_map) + ret.append(self.babel_renewcommand('\\figurename', definition)) + if figure[1]: + ret.append('\\makeatletter\n') + ret.append('\\def\\fnum@figure{\\figurename\\thefigure%s}\n' % + str(figure[1]).strip().translate(tex_escape_map)) + ret.append('\\makeatother\n') + + table = self.builder.config.numfig_format['table'].split('%s', 1) + if len(table) == 1: + ret.append('\\def\\fnum@table{%s}\n' % + str(table[0]).strip().translate(tex_escape_map)) + else: + definition = str(table[0]).strip().translate(tex_escape_map) + ret.append(self.babel_renewcommand('\\tablename', definition)) + if table[1]: + ret.append('\\makeatletter\n') + ret.append('\\def\\fnum@table{\\tablename\\thetable%s}\n' % + str(table[1]).strip().translate(tex_escape_map)) + ret.append('\\makeatother\n') + + codeblock = self.builder.config.numfig_format['code-block'].split('%s', 1) + if len(codeblock) == 1: + pass # FIXME + else: + definition = str(codeblock[0]).strip().translate(tex_escape_map) + ret.append(self.babel_renewcommand('\\literalblockname', definition)) + if codeblock[1]: + pass # FIXME + + return ''.join(ret) + + # Import old modules here for compatibility import sphinx.builders.latex.compat # NOQA