From dcb211f5de2fb18f7162b0fc261fa368b1ac7a18 Mon Sep 17 00:00:00 2001
From: jfbu <jfbu@free.fr>
Date: Sat, 11 Feb 2017 11:58:38 +0100
Subject: [PATCH] refactor latex table templates to avoid extra vertical spaces
 (refs #3405)

also, make "center" the default for short table horizontal alignment (it
is already so for longtable)
---
 sphinx/templates/latex/tabular.tex_t  | 30 +++++++++++++-------------
 sphinx/templates/latex/tabulary.tex_t | 30 +++++++++++++-------------
 tests/test_build_latex.py             | 31 ++++++++++++++-------------
 3 files changed, 46 insertions(+), 45 deletions(-)

diff --git a/sphinx/templates/latex/tabular.tex_t b/sphinx/templates/latex/tabular.tex_t
index 7aeb7e85b..ea8649ccf 100644
--- a/sphinx/templates/latex/tabular.tex_t
+++ b/sphinx/templates/latex/tabular.tex_t
@@ -1,15 +1,20 @@
-<%- if table.align %>
+\begingroup
+<% if table.align -%>
   <%- if table.align == 'center' -%>
-    \begin{center}
-  <%- elif table.align in ('left', 'right') -%>
-    \begin{flush<%= table.align%>}
-  <%- endif -%>
-<% endif -%>
-<%- if table.caption -%>
+  \centering
+  <%- elif table.align == 'left' -%>
+  \raggedright
+  <%- else -%>
+  \raggedleft
+  <%- endif %>
+<%- else -%>
+  \centering
+<%- endif %>
+<% if table.caption -%>
 \begin{threeparttable}
 \capstart\caption{<%= ''.join(table.caption) %>}<%= labels %>
 <% endif -%>
-\noindent\begin{tabular}<%= table.get_colspec() -%>
+\begin{tabular}<%= table.get_colspec() -%>
 \hline
 <%= ''.join(table.header) %>
 <%=- ''.join(table.body) %>
@@ -17,10 +22,5 @@
 <%- if table.caption %>
 \end{threeparttable}
 <%- endif %>
-<%- if table.align %>
-  <%- if table.align == 'center' -%>
-    \end{center}
-  <%- elif table.align in ('left', 'right') -%>
-    \end{flush<%= table.align%>}
-  <% endif -%>
-<% endif -%>
+\par
+\endgroup
diff --git a/sphinx/templates/latex/tabulary.tex_t b/sphinx/templates/latex/tabulary.tex_t
index d09a4b14b..fed923f8b 100644
--- a/sphinx/templates/latex/tabulary.tex_t
+++ b/sphinx/templates/latex/tabulary.tex_t
@@ -1,15 +1,20 @@
-<%- if table.align %>
+\begingroup
+<% if table.align -%>
   <%- if table.align == 'center' -%>
-    \begin{center}
-  <%- elif table.align in ('left', 'right') -%>
-    \begin{flush<%= table.align%>}
-  <%- endif -%>
-<% endif -%>
-<%- if table.caption -%>
+  \centering
+  <%- elif table.align == 'left' -%>
+  \raggedright
+  <%- else -%>
+  \raggedleft
+  <%- endif %>
+<%- else -%>
+  \centering
+<%- endif %>
+<% if table.caption -%>
 \begin{threeparttable}
 \capstart\caption{<%= ''.join(table.caption) %>}<%= labels %>
 <% endif -%>
-\noindent\begin{tabulary}{\linewidth}<%= table.get_colspec() -%>
+\begin{tabulary}{\linewidth}<%= table.get_colspec() -%>
 \hline
 <%= ''.join(table.header) %>
 <%=- ''.join(table.body) %>
@@ -17,10 +22,5 @@
 <%- if table.caption %>
 \end{threeparttable}
 <%- endif %>
-<%- if table.align %>
-  <%- if table.align == 'center' -%>
-    \end{center}
-  <%- elif table.align in ('left', 'right') -%>
-    \end{flush<%= table.align%>}
-  <% endif -%>
-<% endif -%>
+\par
+\endgroup
diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py
index 81b9b79b1..95b7273f0 100644
--- a/tests/test_build_latex.py
+++ b/tests/test_build_latex.py
@@ -481,7 +481,7 @@ def test_footnote(app, status, warning):
             '\ncite\n}') in result
     assert '\\caption{Table caption \\sphinxfootnotemark[4]' in result
     assert 'name \\sphinxfootnotemark[5]' in result
-    assert ('\\end{threeparttable}\n%\n'
+    assert ('\\end{threeparttable}\n\\par\n\\endgroup\n%\n'
             '\\begin{footnotetext}[4]\sphinxAtStartFootnote\n'
             'footnotes in table caption\n%\n\\end{footnotetext}%\n'
             '\\begin{footnotetext}[5]\sphinxAtStartFootnote\n'
@@ -831,7 +831,7 @@ def test_latex_table_tabulars(app, status, warning):
 
     # simple_table
     table = tables['simple table']
-    assert ('\\noindent\\begin{tabulary}{\\linewidth}{|L|L|}' in table)
+    assert ('\\begin{tabulary}{\\linewidth}{|L|L|}' in table)
     assert ('\\hline\n'
             '\\sphinxstylethead{\\relax \nheader1\n\\unskip}\\relax &'
             '\\sphinxstylethead{\\relax \nheader2\n\\unskip}\\relax' in table)
@@ -842,42 +842,43 @@ def test_latex_table_tabulars(app, status, warning):
 
     # table having :widths: option
     table = tables['table having :widths: option']
-    assert ('\\noindent\\begin{tabular}{|\\X{30}{100}|\\X{70}{100}|}' in table)
+    assert ('\\begin{tabular}{|\\X{30}{100}|\\X{70}{100}|}' in table)
     assert ('\\hline\n\\end{tabular}' in table)
 
     # table having :align: option (tabulary)
     table = tables['table having :align: option (tabulary)']
-    assert ('\\begin{center}\\noindent\\begin{tabulary}{\\linewidth}{|L|L|}\n' in table)
-    assert ('\\hline\n\\end{tabulary}\\end{center}' in table)
+    assert ('\\begingroup\n\\centering\n'
+            '\\begin{tabulary}{\\linewidth}{|L|L|}\n' in table)
+    assert ('\\hline\n\\end{tabulary}\n\\par\n\\endgroup' in table)
 
     # table having :align: option (tabular)
     table = tables['table having :align: option (tabular)']
-    assert ('\\begin{flushleft}'
-            '\\noindent\\begin{tabular}{|\X{30}{100}|\X{70}{100}|}\n' in table)
-    assert ('\\hline\n\\end{tabular}\\end{flushleft}' in table)
+    assert ('\\begingroup\n\\raggedright\n'
+            '\\begin{tabular}{|\X{30}{100}|\X{70}{100}|}\n' in table)
+    assert ('\\hline\n\\end{tabular}\n\\par\n\\endgroup' in table)
 
     # table with tabularcolumn
     table = tables['table with tabularcolumn']
-    assert ('\\noindent\\begin{tabulary}{\\linewidth}{|c|c|}' in table)
+    assert ('\\begin{tabulary}{\\linewidth}{|c|c|}' in table)
 
     # table having caption
     table = tables['table having caption']
     assert ('\\begin{threeparttable}\n\\capstart\\caption{caption for table}'
             '\\label{\\detokenize{tabular:id1}}' in table)
-    assert ('\\noindent\\begin{tabulary}{\\linewidth}{|L|L|}' in table)
+    assert ('\\begin{tabulary}{\\linewidth}{|L|L|}' in table)
     assert ('\\hline\n\\end{tabulary}\n\\end{threeparttable}' in table)
 
     # table having verbatim
     table = tables['table having verbatim']
-    assert ('\\noindent\\begin{tabular}{|*{2}{\\X{1}{2}|}}\n\\hline' in table)
+    assert ('\\begin{tabular}{|*{2}{\\X{1}{2}|}}\n\\hline' in table)
 
     # table having problematic cell
     table = tables['table having problematic cell']
-    assert ('\\noindent\\begin{tabular}{|*{2}{\\X{1}{2}|}}\n\\hline' in table)
+    assert ('\\begin{tabular}{|*{2}{\\X{1}{2}|}}\n\\hline' in table)
 
     # table having both :widths: and problematic cell
     table = tables['table having both :widths: and problematic cell']
-    assert ('\\noindent\\begin{tabular}{|\\X{30}{100}|\\X{70}{100}|}' in table)
+    assert ('\\begin{tabular}{|\\X{30}{100}|\\X{70}{100}|}' in table)
 
 
 @pytest.mark.skipif(docutils.__version_info__ < (0, 13),
@@ -958,7 +959,7 @@ def test_latex_table_complex_tables(app, status, warning):
 
     # grid table
     table = tables['grid table']
-    assert ('\\noindent\\begin{tabulary}{\\linewidth}{|L|L|L|}' in table)
+    assert ('\\begin{tabulary}{\\linewidth}{|L|L|L|}' in table)
     assert ('\\hline\n'
             '\\sphinxstylethead{\\relax \nheader1\n\\unskip}\\relax &'
             '\\sphinxstylethead{\\relax \nheader2\n\\unskip}\\relax &'
@@ -975,7 +976,7 @@ def test_latex_table_complex_tables(app, status, warning):
 
     # complex spanning cell
     table = tables['complex spanning cell']
-    assert ('\\noindent\\begin{tabulary}{\\linewidth}{|L|L|L|L|L|}' in table)
+    assert ('\\begin{tabulary}{\\linewidth}{|L|L|L|L|L|}' in table)
     assert ('\\hline\n'
             '\\multirow{3}{*}{\\relax \ncell1-1\n\\unskip}\\relax &'
             '\\multirow{3}{*}{\\relax \ncell1-2\n\\unskip}\\relax &'