summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/pythonhighlight/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/pythonhighlight/README.md')
-rw-r--r--macros/latex/contrib/pythonhighlight/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/macros/latex/contrib/pythonhighlight/README.md b/macros/latex/contrib/pythonhighlight/README.md
new file mode 100644
index 0000000000..06fc5b02af
--- /dev/null
+++ b/macros/latex/contrib/pythonhighlight/README.md
@@ -0,0 +1,33 @@
+Python highlighting in LaTeX
+============================
+
+A simple Python highlighting style to be used with LaTeX.
+
+The package is loaded by the following line:
+
+```tex
+\usepackage{pythonhighlight}
+```
+
+It is then possible to include a Python snippet directly in the code using:
+
+```tex
+\begin{python}
+def f(x):
+ return x
+\end{python}
+```
+
+It is also possible to include inline Python code in LaTeX with ``\pyth``:
+
+```tex
+The special method \pyth{__init__}...
+```
+
+Last but not least, you can load an external Python file with:
+
+```tex
+\inputpython{python_file.py}{23}{50}
+```
+
+to display the contents of the file ``python_file`` from line 23 to line 50.