literal blocks in footnotes are not supported by Latex

[itfanr]

During converting rst to tex, I got the error.

gotgit/gotgithub#24

[jfbu]

This issue is part of #2616.

Memo: currently already Sphinx uses package LaTeX footnote.sty but not its footnote environment which allows verbatim material. However footnote.sty is old and has bugs (incompatibility with xcolor and unawareness of hyperref in particular). Package footnotehyper fixes some such issues. It could be shipped with Sphinx taking place of the currently shipped custom tabulary.sty which incorporate a change for compatibilty with old package footnote.sty.

[jfbu]

@tk0miya I have a branch at https://github.com/jfbu/sphinx/tree/improvefootnotes which now allows code-blocks within footnotes. I need to do some testing, it is not mature enough for a PR. Initially the branch was about improving footnotes inside table. It was stale for some months, now I have renamed and revived it. From the point of view of hyperlinks, the problem is that LaTeX's hyperref does not implement them if the code uses \footnotemark[N]/\footnotetext[N] syntax, which various parts of Sphinx use in tables.

As per allowing code-blocks we use environment form of footnote. This needs own Sphinx shipped latex package.

[jfbu]

I have rebased and updated https://github.com/jfbu/sphinx/tree/improvefootnotes at jfbu@b5a9685. This version updates the root tests. It allows code-blocks in footnotes, even with captions ! Also hyperlinking of footnotes is improved.

Further needed improvements: modify latex.py so that the footnotes will use \footnotemark[N] in less cases. Only need in captions and inside tabulary. There is no need in longtable cells.

[itfanr]

@jfbu Thank you for your answer.

[jfbu]

PR #3022

[itfanr]

@jfbu What I know about sphinx is less . I will look into it when I am free . Thank you .

[jfbu]

fixed at b8e0e93 for 1.5a2 pre-release. Thanks for reporting !

[itfanr]

@jfbu Thank you .