Merge pull request #185 from ktaletsk/issue-122

Update documentation and Binder with c.LatexConfig.run_times

Author: ktaletsk

README.md

@@ -89,6 +89,13 @@ by setting
 c.LatexConfig.bib_command = '<custom_bib_command>'
 ```
 
+To render references (`\ref{...}`), such as equation or chapter numbers, you would
+need to compile in multiple passes by setting
+
+```python
+c.LatexConfig.run_times = 2
+```
+
 ### Security and customizing shell escapes
 
 LaTeX files have the ability to run arbitrary code by triggering external

binder/jupyter_notebook_config.py

@@ -0,0 +1 @@
+c.LatexConfig.run_times = 2

binder/start

@@ -0,0 +1,12 @@
+#!/usr/bin/env python3
+import sys
+import shutil
+import os
+
+argv = sys.argv[1:] + ['--config', 'binder/jupyter_notebook_config.py']
+print(argv)
+
+with open('startup_args.txt', 'w') as fid:
+    fid.write(str(argv))
+
+os.execv(shutil.which(argv[0]), argv)

sample.tex

@@ -22,6 +22,7 @@ \section{Introduction}
 \begin{equation}
     \rho \left( \frac{\partial \mathbf{u}}{\partial t} + \mathbf{u} \cdot \nabla \mathbf{u} \right) =
     -\nabla P + \eta \nabla^2 \mathbf{u} + \rho \mathbf{g}.
+\label{eq:Navier–Stokes}
 \end{equation}
 \\
 \\
@@ -36,6 +37,8 @@ \section{Introduction}
   \end{tabular}
 \end{center}
 
+We can reference equations by their numbers, i.e. Equation (\ref{eq:Navier–Stokes}).
+
 \subsection{We can add new subsections}
 And we can include images, such as the Jupyter logo:
 \begin{center}