summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/runcode/runcode.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/runcode/runcode.tex')
-rw-r--r--macros/latex/contrib/runcode/runcode.tex16
1 files changed, 11 insertions, 5 deletions
diff --git a/macros/latex/contrib/runcode/runcode.tex b/macros/latex/contrib/runcode/runcode.tex
index 5d99475739..977a41bc24 100644
--- a/macros/latex/contrib/runcode/runcode.tex
+++ b/macros/latex/contrib/runcode/runcode.tex
@@ -1,6 +1,6 @@
- % LaTeX Package: runcode v1.0 2020/10/04
+ % LaTeX Package: runcode v1.1 2021/04/17
%
- % Copyright (C) 2020 by Haim Bar and HaiYing Wang
+ % Copyright (C) 2021 by Haim Bar and HaiYing Wang
%
% This file may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either
@@ -15,9 +15,9 @@
\documentclass{ltxdoc}
\usepackage[hyphens]{url}
%\usepackage{runcode}
-\ProvidesPackage{runcode}[2020/10/04 runcode v1.0]
+\ProvidesPackage{runcode}[2021/04/17 runcode v1.1]
\begin{document}
- \title{The \textsf{runcode} package\thanks{This document corresponds to \textsf{runcode}~v1.0, dated~2020/10/04.}}
+ \title{The \textsf{runcode} package\thanks{This document corresponds to \textsf{runcode}~v1.1, dated~2021/04/17.}}
\author{Haim Bar and HaiYing Wang \\ \texttt{haim.bar@uconn.edu}, \texttt{haiying.wang@uconn.edu}}
\maketitle
@@ -25,7 +25,7 @@
It is recommended to use this package in the server-mode together with the Python talk2stat package. Currently, the server-mode supports Julia, MatLab, Python, and R. More languages will be added.
-For more details and usage examples, refer to the package's github repository, at
+For more details and usage examples and troubleshooting, refer to the package's github repository, at
\url{https://github.com/Ossifragus/runcode}.
}
@@ -49,6 +49,7 @@ Available options are:
\item \texttt{run}: run source code, and store results in cache files.
\item \texttt{cache}: use cached results.
\item \texttt{stopserver}: stop the \textit{talk2stat} server(s) when the pdf compilation is done.
+\item \texttt{nohup}: when using the server-mode, some editors terminate all child processes after LaTeX compiling such as Emacs with Auctex. For this case, use the nohup option. It set the variable notnohup to be false, and the server will not be terminated by the parent process.
\item \texttt{nominted}: use the \textit{fvextra} package [\url{https://ctan.org/pkg/fvextra}] instead of the \textit{minted} package [\url{https://ctan.org/pkg/minted}] to show code (\textit{fvextra} does not require Python's pygments package [\url{https://pygments.org/}], but it does not provide syntax highlights).
\end{itemize}
* Requires the Python package \textit{talk2stat} to be installed.
@@ -140,6 +141,11 @@ Available options are:
\end{itemize}
+\section{Revisions}
+\begin{itemize}
+\item v1.1, April 17, 2021: Added a nohup option; improved error handling (missing code files, zero bytes in output files.)
+\end{itemize}
+
%
\section{Contributing}
We welcome your contributions to this package by opening issues on GitHub and/or making a pull request. We also appreciate more example documents written using \textsf{runcode}.