Skip to content
This repository was archived by the owner on Apr 24, 2020. It is now read-only.

Conversion to PDF (Edge Cases and Conversion Issues)

mmcky edited this page Jul 9, 2019 · 25 revisions

Conversion Issues

rst ipynb latex(pandoc) impacts issue description update resolved
( %28 ref construction Opening bracket in the heading is replaced by %28 in ipynb file for HTML conversion but a bracket in the heading is simply ignored by pandoc and thus creates undefined reference issues [extension] make %28 an option jupyter_target_pdf https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/210
) %29 headings A closing bracket in the heading is replaced by %29 in ipynb file for HTML conversion but a bracket in the heading is simply ignored by pandoc and thus creates undefined reference issues [extension] make %29 an option jupyter_target_pdf https://github.com/QuantEcon/sphinxcontrib-jupyter/pull/210
🏷️ abc - math equations The HTML links are completely ignored by pandoc thus creating a reference issue if the equations are referenced later in the lecture [extension] remove html tag and form new \tag{#}\label{abc} in jupyter_target_pdf no
.. _abc - sections These labels are to refer to some particular part of the lecture and since HTML links are ignored by pandoc so again reference issues [extension] remove html tag and form new \hypertarget{abc}{} in jupyter_target_pdf. When generating matching links referring to hyper target will need to be \hyperlink{abc}{NAME} no
.. figure:: path/abc.png figures Pandoc is ignoring the HTML links and thus ignoring the figures [extension] ensure make pdf uses jupyter_images_markdown=True to include all images as markdown (scale cannot be used) and issue warning if user tries to set this in conf no
:ref:`abc abc Section \ref{label} internal links Anything in between [] is replaced by section and also the internal link is broken for the lecture [extension] write as \hyperlink{abc}{NAME} in jupyter_target_pdf no
:cite:Rust1996 [Rus96] \href{zreferences.html#rust1996}{{[}Rus96{]}} Citations The cite key for example(Rus96) and the link is preventing pandoc to identify the exact cite label [extension] write \cite{Rust1996} when using jupyter_target_pdf no

Revisit once above are implemented to see if required

rst ipynb latex(pandoc) impacts issue description update resolved
🏷️ abc_xyz abc-xyz abc_xyz labels/citations The underscores and other special characters like "" in labels is replaced by - in ipynb's which is creating undefined citations and references at some places in latex no

Update locations should be:

  1. rst = rst files
  2. extension = sphinxcontrib-jupyter
  3. converter = ipynb-latex-pdf conversion
Clone this wiki locally