summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/source/buildreference.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/source/buildreference.rst b/docs/source/buildreference.rst
index eae9601..2cabe1f 100644
--- a/docs/source/buildreference.rst
+++ b/docs/source/buildreference.rst
@@ -127,3 +127,10 @@ pdflatex
Where *document* is the master tex file of the document and *path* is the
full or relative path to exectue `pdflatex` in.
+
+.. _xnt.build.tex.clean:
+.. function:: clean(path="./", remove_pdf=False)
+
+ Clean up generated output files of `pdflatex` and similar. Currently, the
+ function removes `out`, `log`, `aux`, `toc`, `tol`, `tof`, `tot`, `bbl`,
+ and `blg`. Conditionally, it will remove the generated `pdf` as well.