Wrap tabular environments in adjustbox to resize to page width

[odow]

This most commonly affects tables produced by DatFrames.jl, and resizes them to fit the page if they have many columns that would otherwise run off the right-hand edge of the page.

Closes #1930

This is what it looks like now:

I added a {table} environment with \centering, but I can remove if people object.

[odow]

Linkcheck failure seems like a network issue. It isn't related to this PR.

[mortenpi]

There is still a table in the showcase that manages to overflow.. but that is due to the cells themselves overflowing I guess, which is harder to fight.

Could we add one or two examples with tables to the showcase for this?

Also from the showcase, big equations can be problematic too:

Do you think adjustboxing them could also work to avoid this?

[odow]

I don't know if LaTeX has a way of automatically wrapping text in a table without manually specifying the column widths.

And the equation thing is similarly hard.

[odow]

Math issue is #1470, which was fixed for HTML but not for LaTeX.

[mortenpi]

I am happy to merge this as is too, and leave the equations etc. for the future. If so, this could just use a CHANGELOG note.

[odow]

Added.

p.s. I'm just about to head to the airport, so I'll only be online sporadically until mid-next week.

[mortenpi]

Do you think we should also put an adjustbox around the usual tables (as opposed to ones from show methods)? I.e.

Documenter.jl/src/Writers/LaTeXWriter.jl

Lines 640 to 657 in 674c02e

	function latex(io::Context, node::Node, table::MarkdownAST.Table)
	rows = MarkdownAST.tablerows(node)
	# latex(io, node.children)
	_println(io, "\n\\begin{table}[h]")
	_print(io, "\n\\begin{tabulary}{\\linewidth}")
	_println(io, "{|", uppercase(join(spec_to_align.(table.spec), '|')), "|}")
	for (i, row) in enumerate(rows)
	i === 1 && _println(io, "\\hline")
	for (j, cell) in enumerate(row.children)
	j === 1 || _print(io, " & ")
	latex(io, cell.children)
	end
	_println(io, " \\\\")
	_println(io, "\\hline")
	end
	_println(io, "\\end{tabulary}\n")
	_println(io, "\\end{table}\n")
	end

[odow]

The normal markdown tables already use the {tabulary} environment with the linewidth option, so I think we're okay without?

The problematic tables are really DataFrames because it implements show(::IO, ::MIME"text/latex", ::DataFrame) that produces a {tabular} environment (since it can't use external latex packages).

[mortenpi]

They can still overflow if they're big enough though (you can look at the at-eval generated table I added to the showcase). However, I'm also happy to leave it for a future improvement.

[odow]

I don't really understand why the @eval doesn't get resized, but the @example does?

It's another second-order thing. We're heading in the right direction, and getting everything perfect every time is a really hard job.

[mortenpi]

It's a different latex method that gets called (we print the Markdown[AST].Table directly, and don't rely on the show method), so it doesn't get wrapped in adjustbox right now.

Documenter.jl/src/Writers/LaTeXWriter.jl

Lines 640 to 657 in 674c02e

	function latex(io::Context, node::Node, table::MarkdownAST.Table)
	rows = MarkdownAST.tablerows(node)
	# latex(io, node.children)
	_println(io, "\n\\begin{table}[h]")
	_print(io, "\n\\begin{tabulary}{\\linewidth}")
	_println(io, "{|", uppercase(join(spec_to_align.(table.spec), '|')), "|}")
	for (i, row) in enumerate(rows)
	i === 1 && _println(io, "\\hline")
	for (j, cell) in enumerate(row.children)
	j === 1 || _print(io, " & ")
	latex(io, cell.children)
	end
	_println(io, " \\\\")
	_println(io, "\\hline")
	end
	_println(io, "\\end{tabulary}\n")
	_println(io, "\\end{table}\n")
	end

But as I said, I'm more than happy to merge this as is. As you said, mostly it's DataFrames etc. that cause problems, which the current PR already takes care of.

[odow]

But as I said, I'm more than happy to merge this as is. As you said, mostly it's DataFrames etc. that cause problems, which the current PR already takes care of.

👍 I'm keen to build the JuMP docs once these PRs are all in to see how much of a difference it makes.